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

Add package.json #1

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add package.json #1

wants to merge 2 commits into from

Conversation

TimKam
Copy link

@TimKam TimKam commented Aug 21, 2018

Just an example: package.json for npm. Should be technically sufficient to publish, but adjusting the docs and repo structure would be good.

@chrberger
Copy link
Owner

Thanks @TimKam. Would you suggest to split the JS/C++ part into two separate got repos?

@TimKam
Copy link
Author

TimKam commented Aug 21, 2018

Ah, ok. If I understand it correctly now, the JS library is compiled from a C++ source. Then I recommend to just clean up the repo and docs a bit, to make it easier to understand what is source, what is build, and what are examples, and to add some documentation on how to work with the npm module. I can try to find the time and help.

@TimKam
Copy link
Author

TimKam commented Aug 23, 2018

Here's how to publish npm packages. I was not entirely correct about package signing, as npm does apparently sign packages since a couple of months.

* Add instructions on how to work with the JS lib via npm
  (once published)

* Re-structure repo to allow for a clearer overview

* Update docker files accordingly

* Add Node.js client example, with tutorial

* Update documentation according to changes
@TimKam
Copy link
Author

TimKam commented Aug 25, 2018

@chrberger, here's a comprehensive update:

  • Add instructions on how to work with the JS lib via npm
    (once published)

  • Re-structure repo to allow for a clearer overview

  • Update docker files accordingly

  • Add Node.js client example, with tutorial

  • Update documentation according to changes

Before the changes are merged, it would make sense to first check out this branch and publish libcluon.js on npm, or to publish immediately after merging.

Also, I did not create a docker image for the npm client, which might be a nice addition.

@chrberger
Copy link
Owner

@TimKam Great, thanks. I will pull the branch and test it locally.

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

Successfully merging this pull request may close these issues.

2 participants