docs: add README.md

LICENSE

@@ -0,0 +1,20 @@
+MIT License Copyright (c) 2022 Blobscan <https://blobscan.com>
+
+Permission is hereby granted, free of charge,
+to any person obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute,
+sublicense, and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above
+copyright notice and this permission notice (including the next paragraph) shall
+be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE
+IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
+BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,54 @@
+# Blobscan indexer <a href="#"><img align="right" src=".github/assets/blobi.jpeg" height="80px" /></a>
+
+The indexer for the [Blobscan](https://github.com/Blobscan/blobscan) explorer implemented in Rust.
+
+## How it works?
+
+The indexer crawls the blockchain fetching information from both the Execution and Beacon clients. The data is processed and stored in a MongoDB database.
+
+## How to run locally?
+
+1. Git clone this repo.
+
+```bash
+git clone https://github.com/Blobscan/blobscan-indexer.rs.git
+```
+
+2. Go to directory.
+
+```bash
+cd blobscan-indexer.rs
+```
+
+3. Set the environment variables.
+
+4. Run the indexer.
+
+```bash
+cargo run
+```
+
+## Environment variables
+
+Create a `.env` file with environment variables. You can use the `.env.example` file as a reference.
+
+Below you can find a list of all the required variables:
+
+| Env variable        | Description                                                    |
+| ------------------- | -------------------------------------------------------------- |
+| `DB_CONNECTION_URI` | The connection URI to connect to a deployed database instance. |
+| `DB_NAME`           | The database's name.                                           |
+
+And here a list of optional variables:
+
+| Env variable         | Description                                                                                     | Default value           |
+| -------------------- | ----------------------------------------------------------------------------------------------- | ----------------------- |
+| `BEACON_NODE_RPC`    | A beacon chain RPC node's endpoint.                                                             | `http://localhost:3500` |
+| `EXECUTION_NODE_URL` | An execution RPC node's endpoint.                                                               | `http://localhost:8545` |
+| `LOGGER`             | The logger's name to be used. See log4rs [config file](log4rs.yml) to check the available ones. | `default`               |
+
+# About Blossom Labs
+
+![blossom labs](https://blossom.software/img/logo.svg)
+
+Blobscan is being developed by [Blossom Labs](https://blossom.software/), a developer team specialized in building blockchain-based infrastructure for online communities.