README.md

ArduBadge (Arduino Library-Manager Badge)

Visit the website! www.ardu-badge.com

With the Arduino Library-Manager "Badge" (now ArduBadge) you can notify your users and GitHub visitors that your library is available for download via the built-in Arduino IDE Library Manager.

The badge will show whether the library is available in the Library Manager and if so, what is the latest release available. Clicking on the badge will open up a custom explanation for new users on how to install libraries with the Library Manager and Arduino IDE.

Getting Started

1. To get started visit The Website
2. Look at the Go Badge Yourself section

3. Replace MyLibrary with your own library name
4. Copy the markdown code and use it in your README page!

Examples

Exisitng Libraries:

Non-Existing Libraries:

Contributing

Contributions are welcome! If you have any good ideas in mind dont worry to try them! Firstly make issue about that so we can discuss it. If this issue will be closed and maintainers like your idea, fork this repo and make pull request. When doing this please respect rules included in this file. It includes theese rules and many more. Thanks for your help!

Dependencies

In order to have your own instance of the server, you need to first have:

Software Dependencies

• MongoDB instance
• Node.js & NPM
• React

Node.js Dependencies

• express
• mongoose
• request
• gunzip-file
• download-file
• rimraf

Installing and Deployment

Clone the repository, and run:

1. npm install - to install all server related Node.js dependencies
2. cd client; npm install - to install all client related Node.js dependencies
3. cd client; npm build - to build react client files
4. npm start - to start the server

License

This project is licensed under the MIT License - see the LICENSE.md file for details