From 4b14de0692237aa7d17553520d33fced1163f4ca Mon Sep 17 00:00:00 2001
From: max-crawford <102705427+max-crawford@users.noreply.github.com>
Date: Thu, 5 Oct 2023 09:21:15 -0700
Subject: [PATCH] docs: Update overview.md (#243) [skip ci]

I cleaned up the overview of the Ordinals API. Shortened the intro, grammar tweaks, and added in a section on BRC-20 support
---
 docs/overview.md | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/docs/overview.md b/docs/overview.md
index 73ba6673..19d16c95 100644
--- a/docs/overview.md
+++ b/docs/overview.md
@@ -4,7 +4,7 @@ Title: Overview
 
 # Ordinals API Overview
 
-The Ordinals API is a protocol that allows for Bitcoin inscriptions based on Ordinal theory. It provides a service that indexes Bitcoin Ordinals data and offers a REST API to access and query this data.
+The Ordinals API provides a service that indexes Bitcoin Ordinals data and offers a REST API to access and query this data.
 
 > **_NOTE:_**
 >
@@ -14,14 +14,14 @@ The Ordinals API is a protocol that allows for Bitcoin inscriptions based on Ord
 
 Here are the key features of the Ordinals API:
 
-**Ordinal Inscription Ingestion**: The API helps with the complete ingestion of ordinal inscriptions. This includes information about the Genesis block, transactions, timestamps, and the history of inscriptions associated with each transaction. It also provides location and ownership information.
+**Ordinal Inscription Ingestion**: The API helps with the complete ingestion of ordinal inscriptions. Using our endpoitns, you can retrieve the metadata for a particular inscription, all inscriptions held by a particular address, trading activity for inscriptions, and more.
 
-**Satoshi Ordinal Notation Endpoints**: The API offers endpoints to retrieve ordinal information using Satoshi ordinal notation. This allows you to query specific ordinals and obtain relevant data.
+**BRC-20 Support**: The API offers support for BRC-20 tokens, a fungible token standard built on top of ordinal theory. Retrieve data for a particular BRC-20 token, a user's BRC-20 holdings, marketplace activity, and more.
 
 **REST JSON Endpoints with ETag Caching**: The API provides easy-to-use REST endpoints that return responses in JSON format. It also supports *ETag caching*, which allows you to cache responses based on inscriptions. This helps optimize performance and reduce unnecessary requests.
 
 **Auto-Scale Server Configurations**: The Ordinals API supports three run modes based on the `RUN_MODE` environment variable:
 
-- `default`: This mode runs all background jobs and the API server. It is suitable for running the service on a single instance.
-- `readonly`: In this mode, only the API server runs. It is designed for auto-scaled clusters with multiple `readonly` instances and a single `writeonly` instance. The `writeonly` instance is responsible for populating the database.
-- `writeonly`: This mode is used in an auto-scaled environment to consume new inscriptions. It works in conjunction with multiple `readonly` instances, as explained above.
\ No newline at end of file
+- `default`: This mode runs all background jobs and the API server. It is suitable for running a single instance of the API.
+- `readonly`: Only the API server runs in this mode. It is designed for auto-scaled clusters with multiple `readonly` instances and a single `writeonly` instance. The `writeonly` instance is responsible for populating the database.
+- `writeonly`: This mode is used in an auto-scaled environment to consume new inscriptions and push that data to a database. It works in conjunction with multiple `readonly` instances.