added purpose

populationgenomics · Jan 17, 2024 · a662cf1 · a662cf1
1 parent ca00601
commit a662cf1
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -5,7 +5,7 @@
 
 ## Purpose
 
-Describe the purpose of the project.
+The project provides an interface to interact with the -omics database via the Python client as well as the GraphQL + HTTP APIs.
 
 ## Features
 
@@ -40,10 +40,10 @@ The codebase contains the following modules worth noting:
 
 - `models` -> General data models + enums
 - `db/python/tables` -> Interaction with MariaDB / BigQuery
-- `db/python/layers` -> Business logic
+- `db/python/layers` -> Logic
 - `api/graphql` : GraphQL
 - `api/routes`: HTTP + OpenAPI
 
 And metamist maintains two clients:
-- `web`  -> React APP that consumes a generated Typescript API + GraphQL
+- `web`  -> React app that consumes a generated Typescript API + GraphQL
 - `metamist` -> autogenerated Python API