Updated README removing yarn references and added CONTRIBUTING.md

Author: rohan-deshpande

CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via creating an issue before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. This repository follows the [`git-flow`](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) workflow
+2. After you have made your issue, please create a feature branch off `develop` on your fork and name it in a descriptive way for example `feature/describes-my-feature`
+3. After you have done this, please raise a PR to the `develop` branch, this will ensure that CI runs on your branch before it can be merged 
+4. After your PR has been merged, the library maintainers will cut a release and your change will be made available in a patch, minor or major release shortly
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

README.md

@@ -218,31 +218,31 @@ git clone https://github.com/claus/react-dat-gui.git react-dat-gui
 cd react-dat-gui
 ```
 
-Setup symlinks and install dependencies
+In order to see your changes to `react-dat-gui` the best way is to develop on the package and the example simultaneously. To do this, follow these steps.
+
+### 1. Setup symlinks and install dependencies
 
 ```bash
-yarn install
-yarn link
+npm install
 cd example
-yarn link react-dat-gui
-yarn install
+npm install
 ```
 
-Run the library in development mode
+### 2. Run the library in development mode
 
 ```bash
 cd ..
-yarn start
+npm run dev
 ```
 
-Run the example app in development mode
+### 3. Run the example app in development mode (in second terminal window)
 
 ```bash
 cd example
-yarn start
+npm run dev
 ```
 
-Changes to the library code should hot reload in the demo app
+After the example has compiled, it should be available for viewing at [http://localhost:3000](http://localhost:3000). Changes to the library code should now hot reload in the example app
 
 ## Scripts
 
@@ -272,7 +272,7 @@ Local storage however is in the roadmap and will probably be done very soon.
 - Loading and storing both default and preset data via `localStorage`
 - Animations for `DatFolder` expanding/collapsing
 - Time travel with undo/redo buttons
-- Better support for floating point `DatNumber`s (rounding etc.)
+- ~~Better support for floating point `DatNumber`s (rounding etc.)~~ ✅
 
 ## License