search

finnfiddle / potion

React components for declaratively composing animated, interactive visualizations.
https://potion.js.org/
MIT License
184 stars 5 forks source link

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

Open iMerica opened 5 years ago

iMerica commented 5 years ago

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 commented 5 years ago

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 commented 4 years ago

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