Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/politician/example-generator
Generate usage examples in various formats so people can use your library.
https://github.com/politician/example-generator
Last synced: 25 days ago
JSON representation
Generate usage examples in various formats so people can use your library.
- Host: GitHub
- URL: https://github.com/politician/example-generator
- Owner: politician
- License: apache-2.0
- Created: 2020-07-15T03:08:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T17:36:25.000Z (about 1 year ago)
- Last Synced: 2024-12-14T04:04:59.758Z (27 days ago)
- Language: TypeScript
- Size: 1.61 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Security: docs/SECURITY.md
- Support: docs/SUPPORT.md
Awesome Lists containing this project
README
# JS Example Generator
Generate examples for using your library. This is very opinionated to work with [neat lib](https://github.com/olivr-templates/neat-lib/) however it can still be used as a good base for your use case by extending the class.
**Table of Contents**
- [💾 Installation](#-installation)
- [🔥 Usage](#-usage)
- [💚 Contributing](#-contributing)
- [Top five ways to contribute](#top-five-ways-to-contribute)
- [💡 Todo](#-todo)
- [💬 Support](#-support)
- [📜 License](#-license)
## 💾 Installation
Install with:
- NPM
```sh
npm install example-generator -D
```
- Yarn
```sh
yarn add example-generator -D
```
## 🔥 Usage
## 💚 Contributing
### Top five ways to contribute
⭐ Star this repo: it's quick and goes a long way! [🔝](#top)
🗣️ [Spread the word](docs/CONTRIBUTING.md#spread-the-word)
🐞 [Report bugs](docs/CONTRIBUTING.md#report-bugs)
✅ [Resolve issues](docs/CONTRIBUTING.md#resolve-issues)
📝 [Improve the documentation](docs/CONTRIBUTING.md#improve-the-documentation)
Please see [CONTRIBUTING.md](docs/CONTRIBUTING.md) in the docs folder for more information.
## 💡 Todo
- [ ] Update documentation
- [ ] Tailor [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) to this project's needs
## 💬 Support
Please see [this link](https://keybase.io/team/olivr)
## 📜 License
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details