Improve README

v3xlabs · Apr 18, 2024 · 8d870fa · 8d870fa
1 parent 3faf24a
commit 8d870fa
Showing 1 changed file with 53 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -10,9 +10,7 @@ For demonstration purposes (and one-off usage), a hosted instance is made availa
 
 ### 📌 Example
 
-> [name/luc.eth](https://worker.enstate.rs/n/luc.eth) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [name/rescueorg.eth](https://worker.enstate.rs/n/rescueorg.eth) &nbsp;&nbsp;&nbsp; [name/antony.sh](https://worker.enstate.rs/n/antony.sh)<br />
-> [image/vitalik.eth](https://worker.enstate.rs/i/vitalik.eth)&nbsp;&nbsp;&nbsp; [name/khori.eth](https://worker.enstate.rs/n/khori.eth) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [name/helgesson.eth](https://worker.enstate.rs/n/helgesson.eth)<br />
-> [bulk/address](https://enstate.rs/bulk/a?addresses[]=0x225f137127d9067788314bc7fcc1f36746a3c3B5&addresses[]=0xd577D1322cB22eB6EAC1a008F62b18807921EFBc&addresses[]=0x8F8f07b6D61806Ec38febd15B07528dCF2903Ae7&addresses[]=0x8e8Db5CcEF88cca9d624701Db544989C996E3216&addresses[]=0xb8c2C29ee19D8307cb7255e1Cd9CbDE883A267d5&addresses[]=0xF1F78f308F08fDCAC933124ee8B52A376ff542B4) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [sse/address](https://enstate.rs/sse/a?addresses[]=0x225f137127d9067788314bc7fcc1f36746a3c3B5&addresses[]=0xd577D1322cB22eB6EAC1a008F62b18807921EFBc&addresses[]=0x8F8f07b6D61806Ec38febd15B07528dCF2903Ae7&addresses[]=0x8e8Db5CcEF88cca9d624701Db544989C996E3216&addresses[]=0xb8c2C29ee19D8307cb7255e1Cd9CbDE883A267d5&addresses[]=0xF1F78f308F08fDCAC933124ee8B52A376ff542B4) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [header/luc.eth](https://enstate.rs/h/luc.eth)
+> [name/luc.eth](https://worker.enstate.rs/n/luc.eth) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [name/rescueorg.eth](https://worker.enstate.rs/n/rescueorg.eth) &nbsp;&nbsp;&nbsp; [name/antony.sh](https://worker.enstate.rs/n/antony.sh)<br /> > [image/vitalik.eth](https://worker.enstate.rs/i/vitalik.eth)&nbsp;&nbsp;&nbsp; [name/khori.eth](https://worker.enstate.rs/n/khori.eth) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [name/helgesson.eth](https://worker.enstate.rs/n/helgesson.eth)<br /> > [bulk/address](https://enstate.rs/bulk/a?addresses[]=0x225f137127d9067788314bc7fcc1f36746a3c3B5&addresses[]=0xd577D1322cB22eB6EAC1a008F62b18807921EFBc&addresses[]=0x8F8f07b6D61806Ec38febd15B07528dCF2903Ae7&addresses[]=0x8e8Db5CcEF88cca9d624701Db544989C996E3216&addresses[]=0xb8c2C29ee19D8307cb7255e1Cd9CbDE883A267d5&addresses[]=0xF1F78f308F08fDCAC933124ee8B52A376ff542B4) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [sse/address](https://enstate.rs/sse/a?addresses[]=0x225f137127d9067788314bc7fcc1f36746a3c3B5&addresses[]=0xd577D1322cB22eB6EAC1a008F62b18807921EFBc&addresses[]=0x8F8f07b6D61806Ec38febd15B07528dCF2903Ae7&addresses[]=0x8e8Db5CcEF88cca9d624701Db544989C996E3216&addresses[]=0xb8c2C29ee19D8307cb7255e1Cd9CbDE883A267d5&addresses[]=0xF1F78f308F08fDCAC933124ee8B52A376ff542B4) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [header/luc.eth](https://enstate.rs/h/luc.eth)
 
 ## 🚀 Getting Started
 
@@ -108,3 +106,55 @@ cd worker && pnpm dev
 ```
 
 For more information on running the worker locally, please see [running Cloudflare Workers locally](#run-the-worker-locally).
+
+## Features
+
+Here is a short summary of the features provided by the Enstate API including limitations.
+
+### Avatar & Header Images
+
+An additional `avatar` field at the top level of the ENSProfile object is provided. This field is a URL to the avatar image, with optional gateway rewrites for IPFS and IPNS hashes.
+
+You can also directly access the avatar image of a user by using the `/i/{name}` and `/h/{name}` endpoints.
+
+### Contenthash
+
+Currently **limited implementation**. Only supports `ipfs`.
+TODO add support for `ipns`, `swarm`, `arweave`, `onion`, `onion3`, `skynet`
+
+### Common Records
+
+For each profile we look up the following records:
+You can customize the records you want to query by adjusting the `PROFILE_RECORDS` environment variable.
+Scoping down the size of this list can drastically improve the performance of your requests.
+
+| Record Type | Description |
+| ----------------------------- | ----------------------- |
+| `description` | Description |
+| `url` | URL to the profile |
+| `name` | Name of the profile |
+| `mail` | Email address |
+| `email` | Email address |
+| `avatar` | URL to the avatar |
+| `header` | URL to the header image |
+| `display` | Display name |
+| `location` | Location |
+| `timezone` | Timezone |
+| `language` | Language |
+| `pronouns` | Pronouns |
+| `com.github` | GitHub username |
+| `org.matrix` | Matrix username |
+| `com.twitter` | Twitter username |
+| `com.discord` | Discord username |
+| `social.bsky` | Bsky username |
+| `io.keybase` | Keybase username |
+| `org.telegram` | Telegram username |
+| `social.mastodon` | Mastodon username |
+| `network.dm3.profile` | DM3 profile |
+| `network.dm3.deliveryService` | DM3 delivery service |
+
+### Multichain Support
+
+By default we query profiles for an vast array of chains.
+You can customize the chains you want to query by adjusting the `MULTICOIN_CHAINS` environment variable.
+Forcing it to only chains of interest can drastically improve the performance of your requests.