seperate contributing and readme files

Author: davekay100

CONTRIBUTING.md

@@ -0,0 +1,77 @@
+![Polymath](Polymath.png)
+
+# Polymath.js
+
+Polymath.js is the main library for interacting with Polymath's smart contracts on the client side. It is written in javascript using flow, babel and eslint. The documentation is automatically generated using documentationjs. Checkout the [docs](https://docs.polymath.network)
+
+## Developement Testing on local machine with truffle and mocha
+
+For testing polymathjs source code, clone this repo, then run the following commands. This will set up the environment to run tests on the polymath.js library functionality.
+
+- `yarn prepack`to compile the javascript down to vanilla javascript
+- `yarn testrpc` (keep this terminal running)
+
+In a new terminal
+- `yarn compile` to compile the contracts and create truffle artifacts
+- `yarn migrate-testrpc` to migrate the contracts onto your testrpc
+- `yarn start `(babel compiling) (keep this terminal running)
+
+In a new terminal
+- `yarn test` to test all files
+- `yarn mocha lib/test/{FILENAME.js}` to test a single file
+
+Note: If make changes to source files being compiled by babel, run `yarn clean` to remove the old compiled babel files, and then run `yarn start` to get an updated version with the new code.
+
+## Updating the polymath core contracts into polymath.js
+
+This should only be done when the npm module is ready to be upgraded to a new version of polymath core on the mainnet. The new contracts should be pulled into polymathjs repo, and then worked on in a branch. Once it is known that polymathjs is correctly working on new core contracts, the npm module can be published to reflect this.
+
+The following occurs:
+- Checks that polymath-core is on the master branch
+- Executes git pull on the polymath-core
+- Copies the polymath-core/contract directory into polymath-js directory
+- Removes the polymath-js/build directory
+
+In polymath-js
+- `yarn contracts`
+
+Note: Ensure you have the following file structure
+```
+- polymath (root dir name doesn't matter)
+|-- polymath-js
+|-- polymath-core
+```
+
+## Serving and building documentation
+
+The documentation should be built when the npm module is updated. When you build the docs, the build folder will update, and this repo is connected to netlify which will automatically serve the new documentation to https://docs.polymath.network. So building should only be done when the npm package is ready to upgrade, so that they are in sync.
+
+To serve the docs locally, run:
+
+- `yarn install`
+- `yarn start` to run babel to compile the source code and have it watching for updates (leave this terminal open)
+- `yarn serve-poly-docs`
+
+To build the docs run `yarn build-poly-docs`. Make sure when you make edits, you rebuild the docs so they are added in!
+
+## Contributing
+
+We're always looking for developers to join the polymath network. To do so we
+encourage developers to contribute by creating Security Token Offering contracts
+(STO) which can be used by issuers to raise funds. If your contract is used, you
+can earn POLY fees directly through the contract, and additional bonuses through
+the Polymath reserve fund.
+
+If you would like to apply directly to our STO contract development team, please
+send your resume and/or portfolio to [email protected].
+
+### Styleguide
+
+The polymath-core repo follows the style guide overviewed here:
+http://solidity.readthedocs.io/en/develop/style-guide.html
+
+[polymath]: https://polymath.network
+[ethereum]: https://www.ethereum.org/
+[solidity]: https://solidity.readthedocs.io/en/develop/
+[truffle]: http://truffleframework.com/
+[testrpc]: https://github.com/ethereumjs/testrpc

README.md

@@ -54,57 +54,6 @@ In a new terminal
 
 Then you can use metamask to connected to localhost:8545. You will have to import the private keys from the testrpc into metamask. if you use `yarn testrpc` to start testrpc, then it will use the same 10 private keys everytime, which will be located in the terminal. They will be pre loaded with testrpc ether.
 
-
-## Developement Testing on local machine with truffle and mocha
-
-For testing polymathjs source code, clone this repo, then run the following commands. This will set up the environment to run tests on the polymath.js library functionality.
-
-- `yarn prepack`to compile the javascript down to vanilla javascript
-- `yarn testrpc` (keep this terminal running)
-
-In a new terminal
-- `yarn compile` to compile the contracts and create truffle artifacts
-- `yarn migrate-testrpc` to migrate the contracts onto your testrpc
-- `yarn start `(babel compiling) (keep this terminal running)
-
-In a new terminal
-- `yarn test` to test all files
-- `yarn mocha lib/test/{FILENAME.js}` to test a single file
-
-Note: If make changes to source files being compiled by babel, run `yarn clean` to remove the old compiled babel files, and then run `yarn start` to get an updated version with the new code.
-
-## Updating the polymath core contracts into polymath.js
-
-This should only be done when the npm module is ready to be upgraded to a new version of polymath core on the mainnet. The new contracts should be pulled into polymathjs repo, and then worked on in a branch. Once it is known that polymathjs is correctly working on new core contracts, the npm module can be published to reflect this.
-
-The following occurs:
-- Checks that polymath-core is on the master branch
-- Executes git pull on the polymath-core
-- Copies the polymath-core/contract directory into polymath-js directory
-- Removes the polymath-js/build directory
-
-In polymath-js
-- `yarn contracts`
-
-Note: Ensure you have the following file structure
-```
-- polymath (root dir name doesn't matter)
-|-- polymath-js
-|-- polymath-core
-```
-
-## Serving and building documentation
-
-The documentation should be built when the npm module is updated. When you build the docs, the build folder will update, and this repo is connected to netlify which will automatically serve the new documentation to https://docs.polymath.network. So building should only be done when the npm package is ready to upgrade, so that they are in sync.
-
-To serve the docs locally, run:
-
-- `yarn install`
-- `yarn start` to run babel to compile the source code and have it watching for updates (leave this terminal open)
-- `yarn serve-poly-docs`
-
-To build the docs run `yarn build-poly-docs`. Make sure when you make edits, you rebuild the docs so they are added in!
-
 ## Contributing
 
 We're always looking for developers to join the polymath network. To do so we
@@ -116,6 +65,8 @@ the Polymath reserve fund.
 If you would like to apply directly to our STO contract development team, please
 send your resume and/or portfolio to [email protected].
 
+Please also see the [contributing file](CONTRIBUTING.md) if you want to help with working on the polymathjs library source code!
+
 ### Styleguide
 
 The polymath-core repo follows the style guide overviewed here: