|
| 1 | + |
| 2 | +<!-- PROJECT SHIELDS --> |
| 3 | +<!-- |
| 4 | +*** I'm using markdown "reference style" links for readability. |
| 5 | +*** Reference links are enclosed in brackets [ ] instead of parentheses ( ). |
| 6 | +*** See the bottom of this document for the declaration of the reference variables |
| 7 | +*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. |
| 8 | +*** https://www.markdownguide.org/basic-syntax/#reference-style-links |
| 9 | +--> |
| 10 | +[![CircleCI][circleci-shield]][circleci-url] |
| 11 | +[![CodeCov][codecov-shield]][codecov-url] |
| 12 | +[![Contributors][contributors-shield]][contributors-url] |
| 13 | +[![Forks][forks-shield]][forks-url] |
| 14 | +[![Stargazers][stars-shield]][stars-url] |
| 15 | +[![Issues][issues-shield]][issues-url] |
| 16 | +[![Version][version-shield]][version-url] |
| 17 | +[![MIT License][license-shield]][license-url] |
| 18 | + |
| 19 | + |
| 20 | + |
| 21 | +<!-- PROJECT LOGO --> |
| 22 | +<br /> |
| 23 | +<p align="center"> |
| 24 | + <a href="https://github.com/SurveyMonkey/graphql-introfields"> |
| 25 | + </a> |
| 26 | + |
| 27 | + <h3 align="center">GraphQL Ergonomock</h3> |
| 28 | + |
| 29 | + <p align="center"> |
| 30 | + 🔮 Developer-friendly automagical mocking for GraphQL |
| 31 | + <br /> |
| 32 | + <a href="https://github.com/SurveyMonkey/graphql-introfields/issues">Report Bug</a> |
| 33 | + · |
| 34 | + <a href="https://github.com/SurveyMonkey/graphql-introfields/issues">Request Feature</a> |
| 35 | + </p> |
| 36 | +</p> |
| 37 | + |
| 38 | + |
| 39 | + |
| 40 | +<!-- TABLE OF CONTENTS --> |
| 41 | +## Table of Contents |
| 42 | + |
| 43 | +- [Table of Contents](#table-of-contents) |
| 44 | +- [About The Project](#about-the-project) |
| 45 | + - [Basic Example](#basic-example) |
| 46 | + - [Built With](#built-with) |
| 47 | +- [Getting Started](#getting-started) |
| 48 | + - [Installation](#installation) |
| 49 | + - [Usage](#usage) |
| 50 | +- [Roadmap](#roadmap) |
| 51 | +- [Contributing](#contributing) |
| 52 | +- [License](#license) |
| 53 | +- [Contact](#contact) |
| 54 | +- [Acknowledgements](#acknowledgements) |
| 55 | + |
| 56 | + |
| 57 | + |
| 58 | +<!-- ABOUT THE PROJECT --> |
| 59 | +## About The Project |
| 60 | + |
| 61 | +TBD |
| 62 | + |
| 63 | +### Basic Example |
| 64 | + |
| 65 | +TBD |
| 66 | + |
| 67 | +### Built With |
| 68 | +* [Typescript](https://www.typescriptlang.org/) |
| 69 | +* [GraphQL](https://graphql.org) |
| 70 | +* [Jest](https://jestjs.io) |
| 71 | + |
| 72 | + |
| 73 | + |
| 74 | +<!-- GETTING STARTED --> |
| 75 | +## Getting Started |
| 76 | + |
| 77 | +### Installation |
| 78 | + |
| 79 | +TBD |
| 80 | + |
| 81 | +<!-- USAGE EXAMPLES --> |
| 82 | +### Usage |
| 83 | + |
| 84 | +TBD |
| 85 | + |
| 86 | +<!-- ROADMAP --> |
| 87 | +## Roadmap |
| 88 | + |
| 89 | +See the [open issues](https://github.com/SurveyMonkey/graphql-introfields/issues) for a list of proposed features (and known issues). |
| 90 | + |
| 91 | + |
| 92 | +<!-- CONTRIBUTING --> |
| 93 | +## Contributing |
| 94 | + |
| 95 | +Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. |
| 96 | + |
| 97 | +1. Fork the Project |
| 98 | +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) |
| 99 | +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) |
| 100 | +4. Push to the Branch (`git push origin feature/AmazingFeature`) |
| 101 | +5. Open a Pull Request |
| 102 | + |
| 103 | + |
| 104 | + |
| 105 | +<!-- LICENSE --> |
| 106 | +## License |
| 107 | + |
| 108 | +Distributed under the MIT License. See `LICENSE` for more information. |
| 109 | + |
| 110 | + |
| 111 | +<!-- CONTACT --> |
| 112 | +## Contact |
| 113 | + |
| 114 | +Maintainer: Joel Marcotte (Github [@joual](https://github.com/joual)) |
| 115 | + |
| 116 | +Project Link: [https://github.com/SurveyMonkey/graphql-introfields](https://github.com/SurveyMonkey/graphql-introfields) |
| 117 | + |
| 118 | + |
| 119 | +<!-- ACKNOWLEDGEMENTS --> |
| 120 | +## Acknowledgements |
| 121 | + |
| 122 | +* [A new approach to mocking GraphQL Data](https://www.freecodecamp.org/news/a-new-approach-to-mocking-graphql-data-1ef49de3d491/) |
| 123 | +* [GraphQL-Tools](https://github.com/apollographql/graphql-tools) |
| 124 | +* [GraphQL-JS](https://github.com/graphql/graphql-js) |
| 125 | + |
| 126 | + |
| 127 | +<!-- MARKDOWN LINKS & IMAGES --> |
| 128 | +<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> |
| 129 | +[contributors-shield]: https://img.shields.io/github/contributors/SurveyMonkey/graphql-introfields.svg?style=flat-square |
| 130 | +[contributors-url]: https://github.com/SurveyMonkey/graphql-introfields/graphs/contributors |
| 131 | +[forks-shield]: https://img.shields.io/github/forks/SurveyMonkey/graphql-introfields.svg?style=flat-square |
| 132 | +[forks-url]: https://github.com/SurveyMonkey/graphql-introfields/network/members |
| 133 | +[stars-shield]: https://img.shields.io/github/stars/SurveyMonkey/graphql-introfields.svg?style=flat-square |
| 134 | +[stars-url]: https://github.com/SurveyMonkey/graphql-introfields/stargazers |
| 135 | +[version-url]:https://www.npmjs.com/package/graphql-introfields |
| 136 | +[version-shield]:https://img.shields.io/npm/v/graphql-introfields.svg?style=flat-square |
| 137 | +[issues-shield]: https://img.shields.io/github/issues/SurveyMonkey/graphql-introfields.svg?style=flat-square |
| 138 | +[issues-url]: https://github.com/SurveyMonkey/graphql-introfields/issues |
| 139 | +[license-shield]: https://img.shields.io/github/license/SurveyMonkey/graphql-introfields.svg?style=flat-square |
| 140 | +[license-url]: https://github.com/SurveyMonkey/graphql-introfields/blob/master/LICENSE.txt |
| 141 | +[circleci-shield]: https://circleci.com/gh/SurveyMonkey/graphql-introfields.svg?style=shield |
| 142 | +[circleci-url]: https://app.circleci.com/pipelines/github/SurveyMonkey/graphql-introfields |
| 143 | +[codecov-shield]: https://codecov.io/gh/SurveyMonkey/graphql-introfields/branch/master/graph/badge.svg |
| 144 | +[codecov-url]: https://codecov.io/gh/SurveyMonkey/graphql-introfields |
0 commit comments