updates to the readmes (#574)

Co-authored-by: Flip-Liquid <[email protected]>
Govrn-HQ · Jun 14, 2023 · 71a053c · 71a053c
1 parent 352461f
commit 71a053c
Show file tree

Hide file tree

Showing 16 changed files with 17 additions and 19 deletions.
diff --git a/apps/contract-sync-job/README.md b/apps/contract-sync-job/README.md
@@ -2,7 +2,7 @@
 
 ## Summary
 
-The main purpose of this script is to sync the database with the Contract's events. The Contract's events and mappings are the main source of truth; hence, all events overwrite the existing records in database
+The main purpose of this script is to sync the database with the Contract's events. The Contract's events and mappings are the main source of truth; hence, all events overwrite the existing records in database.
 
 ## Nx Plugin
 

diff --git a/apps/govrn-contract/README.md b/apps/govrn-contract/README.md
@@ -11,9 +11,9 @@ foundryup # install Foundry
 
 #### Setting up local environment
 
-Create .env with env.sample and get the appropriate values. The private key can be taken from an existing anvil account.
+Create .env with env.sample and get the appropriate values. The private key can be taken from an existing Anvil account.
 
-Run local node with anvil with the below command
+Run local node with Anvil with the below command
 
 ```
 anvil

diff --git a/apps/guild-import-job/README.md b/apps/guild-import-job/README.md
@@ -21,5 +21,5 @@ To fetch a guild named `our-guild` from the NATS server stream named `guild-impo
 
 Unfortunately, `nats-server` doesn't include a built-in logging or debugging mode. However, nats CLI provide a convenient ways to interact with the server's state using `nats stream help`, accessing various functionalities and insights about nats server.
 
-Here's a Loom screencast to prepare nats-server for testing:
+Here's a Loom screencast to prepare `nats-server` for testing:
 https://www.loom.com/share/18fad924307f4c14a87fdd0b0ef1458c
diff --git a/apps/jobs/contribution-verification/README.md b/apps/jobs/contribution-verification/README.md
@@ -10,7 +10,7 @@ This primarily will help:
 2. Process guild contributions that were attested to via the deployed contracts but not via the webapp
 3. Process existing guild contributions that we submitted before the guild in question adopted verification criteria
 
-## Nx Plugin
+## nx Plugin
 
 This App is generated using [`@nrwl/node:application`](https://nx.dev/packages/node/generators/application). Check all targets at [`project.json`](./project.json)
 

diff --git a/apps/jobs/twitter-contribution/README.md b/apps/jobs/twitter-contribution/README.md
@@ -2,7 +2,7 @@
 
 ## About
 
-Project description here.
+Project description.
 
 [API Documentation](docs/source/api.md)
 

diff --git a/apps/kevin-malone/README.md b/apps/kevin-malone/README.md
@@ -25,9 +25,7 @@ A self reporting bot for the movement model
   directly in cmd.
 - In your .env file, set the **redis url** to your local instance `REDIS_URL=redis://localhost`
 
-There are available GUI alternative e.g. [DBngin](https://dbngin.com/); It’s a hassle-free way to manage the local Redis
-database
-servers.
+There are available GUI alternative e.g. [DBngin](https://dbngin.com/); It’s a hassle-free way to manage the local Redis database servers.
 
 #### Protocol API
 

diff --git a/apps/linear-sync-job/README.md b/apps/linear-sync-job/README.md
@@ -2,7 +2,7 @@
 
 ## Summary
 
-This Job retrieves all [Linear](https://linear.app) issues and updated all Linear-related Tables. The Job is using Linear [SDK](https://developers.linear.app/docs/sdk/getting-started)
+This Job retrieves all [Linear](https://linear.app) issues and updated all Linear-related Tables. The Job is using Linear [SDK](https://developers.linear.app/docs/sdk/getting-started).
 
 ## Nx Plugin
 

diff --git a/apps/protocol-api/README.md b/apps/protocol-api/README.md
@@ -79,6 +79,6 @@ This App is generated using [`@nrwl/node:application`](https://nx.dev/packages/n
 - `LINEAR_JOB_TOKEN`: Authorization for GraphQL requests for linear sync job
 
 [^1]: uses [`@nx-tools/nx-prisma`](https://github.com/nx-tools/nx-tools/tree/main/packages/nx-prisma) builder that provides a wrapper around the Prisma CLI.
-[^2]: As example it used at [contract-sync-job](../../apps/contract-sync-job/) app, check `CONTRACT_SYNC_TOKEN` env.
+[^2]: As example it used at [contract-sync-job](../../apps/contract-sync-job/) app, check `CONTRACT_SYNC_TOKEN` env
 
 [tables-diagram]: https://i.imgur.com/gETbxIF.png
diff --git a/apps/protocol-frontend/README.md b/apps/protocol-frontend/README.md
@@ -24,7 +24,7 @@ You can check the available commands in the `project.json` file in the frontend
 
 ## Structure
 
-`main.tsx` is the entry point into the app.
+`main.tsx` is the entry point into the frontend app.
 
 The frontend file structure should be familiar to React devs. The core folders are:
 

diff --git a/apps/twitter-contribution-job/README.md b/apps/twitter-contribution-job/README.md
@@ -21,4 +21,4 @@ targets at [`project.json`](./project.json)
 - `BEARER_TOKEN`: Twitter's API bearer Token.
 - `PROTOCOL_URL`: link to gql [endpoint](../protocol-api/README.md#express): `http://localhost:4000/graphql`
 
-[^1]: How to prepare `postgres` and get `DATABASE_URL` go to [`protocol-api`](../protocol-api/README.md#postgres).
+[^1]: How to prepare `postgres` and get `DATABASE_URL` go to [`protocol-api`](../protocol-api/README.md#postgres)
diff --git a/libs/govrn-contract-client/README.md b/libs/govrn-contract-client/README.md
@@ -4,7 +4,7 @@ This library was generated with [Nx](https://nx.dev).
 
 ## Building
 
-Run `nx build govrn-contract-client` to build the library.
+Run `nx build govrn-contract-client` to build the library
 
 ## Running unit tests
 

diff --git a/libs/govrn-subgraph-client/README.md b/libs/govrn-subgraph-client/README.md
@@ -4,7 +4,7 @@ This library was generated with [Nx](https://nx.dev).
 
 ## Building
 
-Run `nx build govrn-subgraph-client` to build the library.
+Run `nx build govrn-subgraph-client` to build the library
 
 ## Running unit tests
 

diff --git a/libs/protocol-client/README.md b/libs/protocol-client/README.md
@@ -16,7 +16,7 @@ This App is generated using [`@nrwl/node:application`](https://nx.dev/packages/n
 
 - first add new query to [`queries.graphql`](./src/lib/graphql/queries.graphql) file.
 - run `yarn nx run protocol-api:serve`, to be able to load GraphQl Schema.
-- run `yarn nx run protocol-client:generate-gql`, [`protocol-types.ts`](./src/lib/protocol-types.ts) will be updated with new modifications.
+- run `yarn nx run protocol-client:generate-gql`, [`protocol-types.ts`](./src/lib/protocol-types.ts) will be updated with new modifications
 
 ## `.env` Variables
 

diff --git a/libs/protocol-ui/README.md b/libs/protocol-ui/README.md
@@ -22,7 +22,7 @@ import { GovrnTheme } from '@govrn/protocol-ui';
 </ChakraProvider>;
 ```
 
-Wrapping the app and passing in `GovrnTheme` provides access to the custom component styles leveraged in the library.
+Wrapping the app and passing in `GovrnTheme` provides access to the custom component styles leveraged in the library
 
 ### Importing Components
 

diff --git a/libs/ui-types/README.md b/libs/ui-types/README.md
@@ -1,6 +1,6 @@
 # ui-types
 
-This library was generated with [Nx](https://nx.dev).
+This library was generated with [Nx](https://nx.dev)
 
 ## Running unit tests
 

diff --git a/libs/utils/README.md b/libs/utils/README.md
@@ -1,6 +1,6 @@
 # utils
 
-This library was generated with [Nx](https://nx.dev).
+This library was generated with [Nx](https://nx.dev)
 
 ## Running unit tests