diff --git a/README.md b/README.md index 688dc2dff..5e23bb952 100644 --- a/README.md +++ b/README.md @@ -42,10 +42,10 @@ A set of services used by [Blockscout](https://blockscout.com/) blockchain explo ## Running and configuring services -Services are distributed as docker images. For each service you can find information about packages and their recent releases +Services are distributed as docker images. For each service, you can find information about packages and their recent releases inside service directories. -You can configure your app by passing necessary environment variables when starting the container. +You can configure your app by passing the necessary environment variables when starting the container. Configuration variables common for all services can be found [here](docs/common-envs.md). See full list of ENVs and their description inside service directories. @@ -73,13 +73,13 @@ The separation on "logic" and "server" crates is designed to separate functional For now, "server" crates contain gRPC and HTTP as the transport layer. It was assumed, that users may want to implement their own APIs, for which the library with functional logic might be used. -Crates that require database connection may also have additional sea-orm defined crates: +Crates that require database connection may also have additional sea-orm-defined crates: 1. `{service-name}-migration` - contains migrations for the database 2. `{service-name}-entity` - contains the entity files generated from the schema ## Contributing -We appreciate your support. Before writing code and submitting pull request, please read contributing [instructions](CONTRIBUTING.md). +We appreciate your support. Before writing code and submitting a pull request, please read contributing [instructions](CONTRIBUTING.md). ## License diff --git a/blockscout-ens/README.md b/blockscout-ens/README.md index ebbe4044b..353ac16ef 100644 --- a/blockscout-ens/README.md +++ b/blockscout-ens/README.md @@ -2,7 +2,7 @@ This project provides indexed data of domain name service for blockscout instances. -Here is brief overview of the project stucture: +Here is brief overview of the project structure: ![bens-structure](images/bens.drawio.svg) diff --git a/da-indexer/README.md b/da-indexer/README.md index 17663fa90..20016c665 100644 --- a/da-indexer/README.md +++ b/da-indexer/README.md @@ -98,7 +98,7 @@ just migrate-up ```bash just generate-entities ``` -+ Now you ready to start API server! Just run it: ++ Now you are ready to start API server! Just run it: ``` just run ``` diff --git a/eth-bytecode-db/README.md b/eth-bytecode-db/README.md index ef79a2e2c..d9859db4c 100644 --- a/eth-bytecode-db/README.md +++ b/eth-bytecode-db/README.md @@ -3,7 +3,7 @@ The Ethereum Bytecode Database is a cross-chain smart contract database designed for automatic contract verification. It serves as a proxy between users and the [smart-contract-verifier](../smart-contract-verifier) service. -This servcice stores verified contract data in the database +This service stores verified contract data in the database and enables searches for contracts with similar bytecodes. You will recognize the service in action when you see the notification: