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

move development info into contributing and add install info #1966

Merged
merged 3 commits into from Feb 10, 2017

Conversation

Projects
None yet
2 participants
@Haroenv
Copy link
Member

Haroenv commented Feb 10, 2017

What project are you opening a pull request for?

  • react-instantsearch (use v2 base)

Summary

you had to click on "getting started" on the documentation site to know how react-instantsearch is published on npm, so that was added to the main README.

In my opinion it makes more sense to have the detailed contributing information into a separate file, because it's less relevant if you just want to use it.

Result

The readme is now shorter, and filled with only information you really need when wanting to use react-instantsearch. For detailed info the documentation website is used.

move development info into contributing and add install info
you had to click on "getting started" on the documentation site to know how react-instantsearch is published on npm, so that was added to the main README.

In my opinion it makes more sense to have the detailed contributing information into a separate file, because it's less relevant if you just want to use it.
@vvo
Copy link
Member

vvo left a comment

Nice! Misses right link for doc and a visual information on the main README as for how to CONTRIBUTE.

README.md Outdated
```sh
yarn changelog
```
Detailed info on how to use InstantSearch can be found in the [documentation website](react-doc)

This comment has been minimized.

@vvo

vvo Feb 10, 2017

Member

use [react-doc]

README.md Outdated

## Update docs

This comment has been minimized.

@vvo

vvo Feb 10, 2017

Member

Can we add:

# Contributing, dev, release

Read the CONTRIBUTING guide (link)

thx

Haroenv and others added some commits Feb 10, 2017

add contributing info link in readme
also fix wrong markdown link to the site

@vvo vvo merged commit dbd6cf0 into v2 Feb 10, 2017

0 of 2 checks passed

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
deploy/netlify Deploy preview processing.
Details

@vvo vvo deleted the docs/react-readme-shorter branch Feb 10, 2017

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