Skip to content

Commit

Permalink
docs(react): update links in carbon-components-react readme (#4746)
Browse files Browse the repository at this point in the history
* docs(react): update links in carbon-components-react readme

* docs(react): update link to components package

* docs(react): format readme

* docs(react): update wording per PR feedback

Co-Authored-By: Josh Black <josh@josh.black>
  • Loading branch information
jendowns and joshblack committed Nov 22, 2019
1 parent b58c39d commit a282fc3
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions packages/react/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# carbon-components-react

> A collection of [Carbon Components](https://github.com/IBM/carbon-components)
> A collection of
> [Carbon Components](https://github.com/carbon-design-system/carbon/tree/master/packages/components)
> implemented using [React](https://reactjs.org/).
### Getting Started
Expand Down Expand Up @@ -34,7 +35,7 @@ yarn add carbon-components-react carbon-components carbon-icons
[`carbon-components-react/.storybook/polyfills.js` file](./.storybook/polyfills.js)
is required.

If you just want to try out `carbon-components-react`, you can also use
If you only want to try out `carbon-components-react`, you can also use
[CodeSandbox](https://codesandbox.io/s/github/carbon-design-system/carbon/tree/master/packages/react/examples/codesandbox).

[![Edit carbon-components-react](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/carbon-design-system/carbon/tree/master/packages/react/examples/codesandbox)
Expand Down Expand Up @@ -62,9 +63,9 @@ can see usage information in several ways:

# :books: Documentation

- See our documentation site
[here](http://carbondesignsystem.com/getting-started/developers) for full
how-to docs and guidelines
- See our
[documentation site](https://www.carbondesignsystem.com/get-started/develop/react)
for full how-to docs and guidelines
- [Contributing](/.github/CONTRIBUTING.md): Guidelines for making contributions
to this repo
- [🏃‍♀️ Migration Guides](./docs/migration)
Expand Down

0 comments on commit a282fc3

Please sign in to comment.