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

Missing yarn/npm install step in Docs Site and README. #11

Open
iMerica opened this issue Mar 31, 2019 · 2 comments
Open

Missing yarn/npm install step in Docs Site and README. #11

iMerica opened this issue Mar 31, 2019 · 2 comments

Comments

@iMerica
Copy link

iMerica commented Mar 31, 2019

Hi,

This library looks interesting, but I have no idea how to add it to my project because the package name isn't listed anywhere on the readme or the docs site.

Installation is the first step – it's important enough to put on the home page of your docs site and the README.md

Thank you,

Michael

@BossBele
Copy link

I had the same problem. After extensive searching, I managed to find the project on npm. Here are all the useful links to get you started:
https://bestofjs.org/projects/potion
https://www.npmjs.com/package/number-picture

Note:
potion js was previously numberpicture js as declared below:
https://medium.com/@numberpicture/numberpicture-js-becomes-potion-fbf6425b3188
The link takes you to potion-js' account on medium. They also state that they have refactored the library out into several submodules: @potion/element, @potion/layout, @potion/extra and @potion/util.

These modules are all found on npm by their respective names. Links:
https://www.npmjs.com/package/@potion/element
https://www.npmjs.com/package/@potion/layout
https://www.npmjs.com/package/@potion/extra
https://www.npmjs.com/package/@potion/util

Other associated projects include:
https://www.npmjs.com/package/@potion/color
https://www.npmjs.com/package/@potion/main
https://www.npmjs.com/package/@potion/dev

I have to agree that the documentation on installation hasn't been great. But I hope the links will help you.

@finnfiddle
Copy link
Owner

a bit delayed but @iMerica thanks for the feedback - I will add installation docs. @BossBele thanks for collecting the info here

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