Repository files navigation

This repository contains the list of libraries in theArduino Library Manager index.

• Frequently asked questions
• Adding a library to Library Manager
  • Instructions
    • If the problem is with the pull request:
    • If the problem is with the library:
• Changing the URL of a library already in Library Manager
• Removing a library from Library Manager
• Report a problem with Library Manager
• Security & Malware Reporting

For more information about Arduino Library Manager and how the index is maintained, please seethe FAQ.

If you would like to make a library available for installation via Library Manager, just submit apull requestthat adds the repository URL tothe list. You are welcome to add multiple libraries at once.

See the instructions below for detailed instructions on how to do this via the GitHub web interface.

⚠ If you behave irresponsibly in your interactions with this repository, your Library Manager Registry privileges will be revoked.

Carefully read and follow the instructions in any comments the bot and human maintainers make on your pull requests. If you are having trouble following the instructions, add a comment that provides a detailed description of the problem you are having and a human maintainer will provide assistance.

Although we have set up automation for the most basic tasks, this repository is maintained by humans. So behave in a manner appropriate for interacting with humans, including clearly communicating what you are hoping to accomplish.

1. You may want to first take a look atthe requirements for admission into the Arduino Library Manager index. Each submission will be checked forcompliance before being accepted.

2. Click the following link:
   https://github.com/arduino/library-registry/fork
   The "Create a new fork" page will open.

3. Click theCreate fork button in the "Create a new fork" page.
   A "Forking arduino/library-registry" page will open while the fork is in the process of being created.

4. Wait for the "Forking" process to finish.
   The home page of yourfork of thelibrary-registry repository will open.

5. Click on the filerepositories.txt under the list of files you see in that page.
   The "library-registry/repositories.txt" page will open.

6. Click the pencil icon ("Edit this file") at the right side of the toolbar in the "library-registry/repositories.txt" page.
   Therepositories.txt file will open in the online text editor.

7. Add the library repository's URL to the list (it doesn't matter where in the list). This should be the URL of the repository home page. For example:https://github.com/arduino-libraries/Servo

8. Click theCommit changes... button located near the top right corner of the page.
   The "Commit changes" dialog will open.

9. Click theCommit changes button in the "Commit changes" dialog.
   The "library-registry/repositories.txt" page will open.

10. Click the "library-registry" link at the top of the "library-registry/repositories.txt" page.
    The home page of your fork of thelibrary-registry repository will open.

11. You should see a banner on the page that says:

    This branch is 1 commit ahead of arduino:main.

    Click the "Contribute" link near the right side of that banner.
    A menu will open.

12. Click theOpen pull request button in the menu.
    The "Open a pull request" page will open.

13. In the"Open a pull request" window that opens, click theCreate pull request button.

The library will be automatically checked for compliance as soon as the pull request is submitted. If no problems werefound, the pull request will be immediately merged and the library will be available for installation via LibraryManager within a day's time.

If any problems are found, a bot will comment on the pull request to tell you what is wrong. The problem may be eitherwith your pull request or with the library.

Edit the file in thebranchyou submitted the pull request from in your fork of thearduino/library-registry repository, then commit.

Doing this will update the pull request and cause the automated checks to run again.

1. Make the necessary fix in the library repository.
2. Increment theversion value in the library'slibrary.properties file.
3. Create areleaseortag. The Library Manager index always uses tagged versions of the libraries,so even if the development version of the library is compliant, it can't be accepted until the latest release or tagis compliant. Alternatively, you can redo the existing release/tag if you prefer.
4. Comment on your pull request here in thearduino/library-registry repository, mentioning@ArduinoBot in thecomment. Doing this will cause the automated check to run again.

Submit a pull request that changes the URL as desired inrepositories.txt. This can be done byfollowingthe instructions above.

Since this type of request must be reviewed by a human maintainer, please write an explanation in the pull requestdescription, making it clear that the URL is intentionally being changed.

Submit a pull request that removes the URL fromrepositories.txt. This can be done by followingthe instructions above.

Since this type of request must be reviewed by a human maintainer, please write an explanation in the pull requestdescription, making it clear that the URL is intentionally being removed.

First, please take a look atthe FAQ. If a library release is missing from Library Manager, it is usuallybecause it was not compliant with allthe requirements listed in that document.

This repository is not an appropriate place to request support or report problems with a library. Check the library'sown documentation for instructions or ask on theArduino Forum.

If the problem is about something else, please submit an issue reporthere.

If you think you found a vulnerability, malware or other security-related defect in any Arduino Library projects, please take a look at our security policy and report it to our Security Team 🛡️.

Thank you!

E-mail contact:security@arduino.cc