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

docs(README): polish it #23

Open
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
2 participants
@kud

kud commented Dec 4, 2018

No description provided.

$ npm install react-scroll-sync
```

## Usage

This comment has been minimized.

@okonet

okonet Dec 4, 2018

Owner

Why adding example here since we already have much more examples and they are even interactive?

This comment has been minimized.

@kud

kud Dec 4, 2018

Sometimes you don't want to have/go to the whole documentation and need to see directly the API, plus this README is forwarded on npm. So having the direct code helps you to understand how easy or not it is to use it.

This comment has been minimized.

@okonet

okonet Dec 4, 2018

Owner

It doesn’t help with maintenance, though. Also it is easy to publish a broken example.

This comment has been minimized.

@kud

kud Dec 4, 2018

Okay, I can remove that if you prefer. :)

This comment has been minimized.

@okonet

okonet Dec 5, 2018

Owner

Ideally I think we could just use one readme.md for GitHub and styleguide. Do you think you could work on that?

This comment has been minimized.

@kud

kud Dec 5, 2018

I love online doc but your package seems quite simple not to have a dedicated documentation. I think a README is enough yes. :)

## Installation

```shell
$ npm install react-scroll-sync

This comment has been minimized.

@okonet

okonet Dec 4, 2018

Owner

Please add --save and yarn version.

This comment has been minimized.

@kud

kud Dec 4, 2018

With the new version of npm, --save is optional as it automatically saves it as --save, it's the default behaviour now. It's useless in fact, except if you want to precise it's a devdep, and use --save-dev

This comment has been minimized.

@kud

kud Dec 4, 2018

Okay for the yarn version even if I think the standard is still to use npm and people on yarn know easily to translate it into yarn way.

I add it most of time to mostly know the name of the package on npm registry.


## Documentation & Example
## Documentation

This comment has been minimized.

@okonet

okonet Dec 4, 2018

Owner

Why removing Example?

This comment has been minimized.

@kud

kud Dec 4, 2018

We can let it but an example is a part of a documentation. Seems useless to me.

This comment has been minimized.

@okonet

okonet Dec 5, 2018

Owner

Okay fair enough.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment