Skip to content

Commit

Permalink
docs: updated ordinals overview page to add a note (#180)
Browse files Browse the repository at this point in the history
  • Loading branch information
LakshmiLavanyaKasturi authored Aug 8, 2023
1 parent 8638377 commit a3f01d9
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ Title: 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.

Here are the key features of the [Ordinals API](https://github.com/hirosystems/ordinals-api):
> **_NOTE:_**
>
> To explore the detailed documentation for the API endpoints, request and response formats, you can refer to the [OpenAPI specification](https://docs.hiro.so/ordinals).
>
> The source code for this project is available in our [GitHub repository](https://github.com/hirosystems/ordinals-api). You can explore the codebase, [contribute](https://docs.hiro.so/contributors-guide), and raise [issues](https://github.com/hirosystems/ordinals-api/issues) or [pull requests](https://github.com/hirosystems/ordinals-api/pulls).
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.

Expand All @@ -18,6 +24,4 @@ Here are the key features of the [Ordinals API](https://github.com/hirosystems/o

- `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.

For more detailed information and documentation, you can refer to the [Ordinals API reference](https://docs.hiro.so/ordinals).
- `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.

0 comments on commit a3f01d9

Please sign in to comment.