Update the token-bridge sub-repo (#19)

* Moved audit to root directory.

* Moved code of conduct, contributing and licence files.

* Removed travis config and badge.

* Updated repository links in CONTRIBUTING.

* Moved Gitter badge to main readme. Updated links to contributing and licence.

* Updated main readme.

* Moved references to main readme.

* Renamed token-bridge to oracle.

* Update README.md

Co-Authored-By: rzadp <[email protected]>

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "token-bridge/submodules/poa-bridge-contracts"]
-	path = token-bridge/submodules/poa-bridge-contracts
+[submodule "oracle/submodules/poa-bridge-contracts"]
+	path = oracle/submodules/poa-bridge-contracts
 	url = https://github.com/poanetwork/poa-bridge-contracts.git

token-bridge/CONTRIBUTING.md → CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 Thank your for contributing to this project! We welcome collaborators and expect users to follow our [code of conduct](CODE_OF_CONDUCT.md) when submitting code or comments.
 
-1. Fork the repo ( https://github.com/poanetwork/bridge-nodejs/fork ).
+1. Fork the repo ( https://github.com/poanetwork/tokenbridge/fork ).
 2. Create your feature branch (`git checkout -b my-new-feature`).
 3. Write tests that cover your work.
 4. Commit your changes (`git commit -am 'Add some feature'`).
@@ -19,10 +19,10 @@ Thank your for contributing to this project! We welcome collaborators and expect
     In either case, try to write a regression test that fails because of the bug but passes with your fix.
 
 ### Issues
-Creating and discussing [Issues](https://github.com/poanetwork/bridge-nodejs/issues) provides significant value to the project. If you find a bug you can report it in an Issue.     
+Creating and discussing [Issues](https://github.com/poanetwork/tokenbridge/issues) provides significant value to the project. If you find a bug you can report it in an Issue.     
 
 ### Pull Requests
 All pull requests should include: 
 * A clear, readable description of the purpose of the PR
 * A clear, readable description of changes
-* Any additional concerns or comments (optional)
+* Any additional concerns or comments (optional)

README.md

@@ -1,5 +1,43 @@
-# tokenbridge
-Monorepository for the token bridge
-
 [![CircleCI](https://circleci.com/gh/poanetwork/tokenbridge.svg?style=svg)](https://circleci.com/gh/poanetwork/tokenbridge)
+[![Gitter](https://badges.gitter.im/poanetwork/poa-bridge.svg)](https://gitter.im/poanetwork/poa-bridge?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![License: LGPL v3.0](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
+
+# Tokenbridge
+Monorepository for the token bridge.
+
+## Structure
+
+Sub-repositories maintained within this monorepo are listed below.
+
+| Sub-repository | Description |
+| --- | --- |
+| [oracle](oracle/README.md) | Oracle responsible for listening to bridge related events and authorizing asset transfers |
+
+## Building, running, linting & tests
+
+To install dependencies:
+
+`yarn install`
+
+Running linter for all projects:
+
+`yarn lint`
+
+Running run tests for all projects:
+
+`yarn test`
+
+For details on building, running and developing please refer to respective READMEs in sub-repositories.
+
+## Contributing
+
+See the [CONTRIBUTING](CONTRIBUTING.md) document for contribution, testing and pull request protocol.
+
+## License
+
+This project is licensed under the GNU Lesser General Public License v3.0. See the [LICENSE](LICENSE) file for details.
+
+## References
 
+* [Additional Documentation](https://forum.poa.network/c/tokenbridge)
+* [POA Bridge FAQ](https://poanet.zendesk.com/hc/en-us/categories/360000349273-POA-Bridge)

token-bridge/README.md → oracle/README.md

@@ -1,10 +1,7 @@
 
-# POA TokenBridge
+# POA Token Bridge - Oracle
 
-[![Build Status](https://travis-ci.org/poanetwork/token-bridge.svg)](https://travis-ci.org/poanetwork/token-bridge)
-[![Gitter](https://badges.gitter.im/poanetwork/poa-bridge.svg)](https://gitter.im/poanetwork/poa-bridge?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
-The TokenBridge is deployed on specified validator nodes (only nodes whose private keys correspond to addresses specified in the smart contracts) in the network. It connects to two chains via a Remote Procedure Call (RPC) and is responsible for:
+The Token Bridge Oracle is deployed on specified validator nodes (only nodes whose private keys correspond to addresses specified in the smart contracts) in the network. It connects to two chains via a Remote Procedure Call (RPC) and is responsible for:
 - listening to events related to bridge contracts
 - sending transactions to authorize asset transfers
 
@@ -282,16 +279,10 @@ When running the processes, the following commands can be used to test functiona
 
 ## Contributing
 
-See the [CONTRIBUTING](CONTRIBUTING.md) document for contribution, testing and pull request protocol.
+See the [CONTRIBUTING](../CONTRIBUTING.md) document for contribution, testing and pull request protocol.
 
 ## License
 
 [![License: LGPL v3.0](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
 
-This project is licensed under the GNU Lesser General Public License v3.0. See the [LICENSE](LICENSE) file for details.
-
-## References
-
-* [Additional Documentation](https://forum.poa.network/c/tokenbridge)
-* [POA Bridge FAQ](https://poanet.zendesk.com/hc/en-us/categories/360000349273-POA-Bridge)
-
+This project is licensed under the GNU Lesser General Public License v3.0. See the [LICENSE](../LICENSE) file for details.