politician / example-generator

Generate usage examples in various formats so people can use your library.

JS Example Generator

Generate examples for using your library. This is very opinionated to work with neat lib however it can still be used as a good base for your use case by extending the class.

Table of Contents

• 💾 Installation
• 🔥 Usage
• 💚 Contributing
  • Top five ways to contribute
• 💡 Todo
• 💬 Support
• 📜 License

💾 Installation

Install with:

• NPM

  npm install example-generator -D

• Yarn

  yarn add example-generator -D

🔥 Usage

💚 Contributing

Top five ways to contribute

⭐ Star this repo: it's quick and goes a long way! 🔝

🗣️ Spread the word

🐞 Report bugs

✅ Resolve issues

📝 Improve the documentation

Please see CONTRIBUTING.md in the docs folder for more information.

💡 Todo

• Update documentation
• Tailor docs/CONTRIBUTING.md to this project's needs

💬 Support

Please see this link

📜 License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details