Merge pull request #93 from CityOfZion/CU-86du5f12p

CU-86du5f12p - Create README with a brief explanation of what the pro…

contributing.md

@@ -0,0 +1,35 @@
+# Contributing to Blockchain Services
+
+We welcome contributions to the Blockchain Services project! Please follow the guidelines below to get started.
+
+## Getting Started
+
+### Setting Up the Development Environment
+1. **Clone the Repository**
+    ```sh
+    git clone https://github.com/CityOfZion/blockchain-services
+    ```
+2. **Install Rush**
+    ```sh
+    cd blockchain-services
+    npm i -g @microsoft/rush
+   ```
+2. **Install Dependencies**
+    ```sh
+    rush update
+    ```
+3. **Build dependencies**
+    ```sh
+    rush rebuild
+    ```
+
+## Testing
+Packages that implement support for a blockchain have test cases under `packages/<package_name>/src/__tests__`.
+
+To run tests:
+```sh
+rush rebuild
+cd packages/<package_name
+rushx test <optional_test_path>
+```
+You can omit the test file path to run all tests for that package.

readme.md

@@ -1,4 +1,23 @@
-# Blockchain Service
-
-Responsible to normalize blockchain operations allowing to use different blockchain technologies abstracting the
-complexity of each one with a single interface.
+# Blockchain Service
+
+## Description
+Collection of packages responsible for normalizing blockchain operations, allowing to use different blockchain technologies by abstracting the
+complexity of each one with a single interface.
+
+## Available packages
+| Package                             | Description                                                                                                                                                    |
+|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| @cityofzion/blockchain-service      | Contains the main interfaces and methods used by different blockchain implementations, as well as utility classes like an aggregator and exchange data service |
+| @cityofzion/bs-asteroid-sdk         | Contains an auxiliary method to generate a mnemonic using @moonlight-io/asteroid-sdk-js                                                                        |
+| @cityofzion/bs-electron             | Responsible for leveraging the communication between main and renderer process, exposing the API to be used in Electron                                        |
+| @cityofzion/bs-ethereum             | Implementation of interfaces and methods for the Ethereum blockchain                                                                                           |
+| @cityofzion/bs-neo3                 | Implementation of interfaces and methods for the NEO 3 blockchain                                                                                              |
+| @cityofzion/bs-neo-legacy           | Implementation of interfaces and methods for the NEO Legacy (NEO 2) blockchain                                                                                 |
+| @cityofzion/bs-react-native-decrypt | Auxiliary methods for decrypting NEO 3 and NEO Legacy keys for React Native, using native code for Android and iOS                                             |
+
+
+## Technologies Used
+- **TypeScript**
+- **React Native**
+- **Java** (for Android native code)
+- **Swift** (for iOS native code)