Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish the library on PlatformIO #10

Closed
marvinroger opened this issue May 9, 2016 · 8 comments
Closed

Publish the library on PlatformIO #10

marvinroger opened this issue May 9, 2016 · 8 comments

Comments

@marvinroger
Copy link

Would you mind publishing this awesome library to PlatformIO? I am currently working on an async MQTT client, and it would be handy not having to download the dependency manually. Thanks!

@me-no-dev
Copy link
Owner

I surely do not mind at all, but I am not a platformio user, so can you please point me in a direction where I can read on what needs to be done for the lib to be supported?

@marvinroger
Copy link
Author

Sure, just add a library.json file to the root of the repo:

{
  "name": "ESPAsyncTCP",
  "keywords": "async, tcp, esp8266, esp32, client, server",
  "description": "Async TCP Library for ESP8266 Arduino",
  "authors":
  {
    "name": "<Your name>"
  },
  "repository":
  {
    "type": "git",
    "url": "https://github.com/me-no-dev/ESPAsyncTCP.git"
  },
  "frameworks": "arduino",
  "platforms": "espressif"
}

Then you just need to run platformio lib register [HTTP_URL_TO_LIBRARY.JSON], and the crawler will automatically update the library on the registry whenever you push new commits, so once registered this is completely transparent.

I guess @ivankravets might even register the library for us. 😃

@me-no-dev
Copy link
Owner

OK I created the json :) I guess I need platformio to platformio lib register [HTTP_URL_TO_LIBRARY.JSON] ? Could you do that since you have it installed and the jsons are already in the repositories for both ESPAsyncTCP and ESPAsyncWebServer?

@marvinroger
Copy link
Author

Well, to be honest I don't have it installed either, but I had a lot of requests asking me to put my own library on the registry. Ivan is the creator of PlatformIO, so he will probably run the appropriate commands to register both libs. ;)

@ivankravets
Copy link
Contributor

Hello from @platformio!

Done! http://platformio.org/lib/show/305/ESPAsyncTCP

Happy Coding! 😊

@marvinroger
Copy link
Author

Awesome, thanks to both of you. :)

@me-no-dev
Copy link
Owner

@ivankravets any chance you add https://raw.githubusercontent.com/me-no-dev/ESPAsyncWebServer/master/library.json to the mix as well? Thank you

@ivankravets
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants