Make ready for npm publishing.

partridgejiang / Kekule.js

A Javascript cheminformatics toolkit.

http://partridgejiang.github.io/Kekule.js

MIT License

250 stars 61 forks source link

Make ready for npm publishing. #29

Closed AaronLlanos closed 6 years ago

AaronLlanos commented 7 years ago

Move package json to top level dir. Correct the main file. (can be changed) Made copy proper dirname into the setup instead of hardcoded windows file extension

Fohlen commented 7 years ago

Hey @AaronLlanos good work so far. Here is my improvement suggestions

the release folder should better be called dist since that's what the vast majority of packages do
you should add a version parameter to your package.json
you should add a git tag once the release is made
this will allow for npm to directly link your repository at kekulegit#version
it would be greatly appreciated if the official README.md is improved, since that will be shown on npm when installed

AaronLlanos commented 6 years ago

@Fohlen I agree with you. But, I am not sure what will be changed if we were to rename folders in the project. Maybe that's something @partridgejiang can comment on/do? I would also like for him to update the README as this is a project I don't know much about. I just jumped in but really want this to be pushed through to NPM so I can get it bundled in my production builds.

AaronLlanos commented 6 years ago

@partridgejiang Before you merge this PR, would you like me to make most of the changes @Fohlen has mentioned here?

partridgejiang commented 6 years ago

Sure and thanks a lot for the excellent work.

partridgejiang commented 6 years ago

I myself have some problems in opening GitHub site these days, and may update the project in few days.

partridgejiang commented 6 years ago

Thanks a lot for @AaronLlanos and @Fohlen, the package has now been published on npmjs.org.