diff --git a/README.md b/README.md index d53d64539..375ec37d3 100644 --- a/README.md +++ b/README.md @@ -134,14 +134,18 @@ The `main` branch contains the latest version of the Datepicker component. To begin local development: -1. `yarn install` -2. `yarn build-dev` -3. `yarn start` +1. Run `yarn link` from project root +2. Run `cd docs-site && yarn link react-datepicker` +3. Run `yarn install` from project root +4. Run `yarn build` from project root +5. Run `yarn start` from project root The last step starts documentation app as a simple webserver on http://localhost:3000. You can run `yarn test` to execute the test suite and linters. To help you develop the component we’ve set up some tests that cover the basic functionality (can be found in `/tests`). Even though we’re big fans of testing, this only covers a small piece of the component. We highly recommend you add tests when you’re adding new functionality. +Please refer to `CONTRIBUTING.md` file for more details about getting set up. + ### The examples The examples are hosted within the docs folder and are ran in the simple app that loads the Datepicker. To extend the examples with a new example, you can simply duplicate one of the existing examples and change the unique properties of your example.