Remove ethereum README refs

dominant-strategies · Jun 4, 2024 · 6645388 · 6645388
1 parent b8f520d
commit 6645388
Showing 1 changed file with 31 additions and 74 deletions.
diff --git a/README.md b/README.md
@@ -1,62 +1,47 @@
 # The quais Project 6.8.1
 
 [![npm (tag)](https://img.shields.io/npm/v/quais)](https://www.npmjs.com/package/quais)
-[![CI Tests](https://github.com/quais-io/quais.js/actions/workflows/test-ci.yml/badge.svg?branch=main)](https://github.com/quais-io/quais.js/actions/workflows/test-ci.yml)
 ![npm bundle size (version)](https://img.shields.io/bundlephobia/minzip/quais)
 ![npm (downloads)](https://img.shields.io/npm/dm/quais)
-[![GitPOAP Badge](https://public-api.gitpoap.io/v1/repo/quais-io/quais.js/badge)](https://www.gitpoap.io/gh/quais-io/quais.js)
-[![Twitter Follow](https://img.shields.io/twitter/follow/ricmoo?style=social)](https://twitter.com/ricmoo)
 
 ---
 
-A complete, compact and simple library for Ethereum and ilk, written
+A complete, compact and simple library for Quai and Qi, written
 in [TypeScript](https://www.typescriptlang.org).
 
 **Features**
 
-- Keep your private keys in your client, **safe** and sound
-- Import and export **JSON wallets** (Geth, Parity and crowdsale)
-- Import and export BIP 39 **mnemonic phrases** (12 word backup phrases) and **HD Wallets** (English as well as Czech, French, Italian, Japanese, Korean, Simplified Chinese, Spanish, Traditional Chinese)
-- Meta-classes create JavaScript objects from any contract ABI, including **ABIv2** and **Human-Readable ABI**
-- Connect to Ethereum nodes over [JSON-RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC), [INFURA](https://infura.io), [quaiscan](https://quaiscan.io), [Alchemy](https://alchemyapi.io), [Ankr](https://ankr.com) or [MetaMask](https://metamask.io)
-- **Small** (~144kb compressed; 460kb uncompressed)
-- **Tree-shaking** focused; include only what you need during bundling
-- **Complete** functionality for all your Ethereum desires
-- Extensive [documentation](https://docs.quais.org/v6/)
-- Large collection of **test cases** which are maintained and added to
-- Fully written in **TypeScript**, with strict types for security and safety
-- **MIT License** (including ALL dependencies); completely open source to do with as you please
+-   Keep your private keys in your client, **safe** and sound
+-   Import and export BIP 39 **mnemonic phrases** (12 word backup phrases) and **HD Wallets** (English as well as Czech, French, Italian, Japanese, Korean, Simplified Chinese, Spanish, Traditional Chinese)
+-   Meta-classes create JavaScript objects from any contract ABI, including **ABIv2** and **Human-Readable ABI**
+-   Connect to Quai nodes over [JSON-RPC](https://qu.ai/docs/develop/apis/json-rpc-api/), [quaiscan](https://quaiscan.io), or [Pelagus](https://pelaguswallet.io)
+-   **Small** (~136kb compressed; 460kb uncompressed)
+-   **Tree-shaking** focused; include only what you need during bundling
+-   **Complete** functionality for all your Ethereum desires
+-   Extensive documentation **coming soon**
+-   Large collection of **test cases** which are maintained and added to
+-   Fully written in **TypeScript**, with strict types for security and safety
+-   **MIT License** (including ALL dependencies); completely open source to do with as you please
 
 ## Keep Updated
 
-For advisories and important notices, follow [@quaisproject](https://twitter.com/quaisproject)
-on Twitter (low-traffic, non-marketing, important information only) as well as watch this GitHub project.
+For advisories and important notices, follow [@quainetwork](https://twitter.com/quaisnetwork)
+on Twitter as well as watch this GitHub project.
 
-For more general news, discussions, and feedback, follow or DM me,
-[@ricmoo](https://twitter.com/ricmoo) on Twitter or on the
-[quais Discord](https://discord.gg/qYtSscGYYc).
+For more general news, discussions, and feedback, join the
+[Quai Developer Discord](https://discord.gg/s8y8asPwNC).
 
-For the latest changes, see the
-[CHANGELOG](https://github.com/quais-io/quais.js/blob/main/CHANGELOG.md).
+**Key Versions**
 
-**Summaries**
-
-- [August 2023](https://blog.ricmoo.com/highlights-quais-js-august-2023-fb68354c576c)
-- [September 2022](https://blog.ricmoo.com/highlights-quais-js-september-2022-d7bda0fc37ed)
-- [June 2022](https://blog.ricmoo.com/highlights-quais-js-june-2022-f5328932e35d)
-- [March 2022](https://blog.ricmoo.com/highlights-quais-js-march-2022-f511fe1e88a1)
-- [December 2021](https://blog.ricmoo.com/highlights-quais-js-december-2021-dc1adb779d1a)
-- [September 2021](https://blog.ricmoo.com/highlights-quais-js-september-2021-1bf7cb47d348)
-- [May 2021](https://blog.ricmoo.com/highlights-quais-js-may-2021-2826e858277d)
-- [March 2021](https://blog.ricmoo.com/highlights-quais-js-march-2021-173d3a545b8d)
-- [December 2020](https://blog.ricmoo.com/highlights-quais-js-december-2020-2e2db8bc800a)
+-   **Coming Soon**: Additional support for Golden Age Testnet, including Qi, provider upgrades, and more.
+-   [0.1.17](https://www.npmjs.com/package/quais/v/0.1.17): Full support for Quai Network's Iron Age Testnet.
 
 ## Installing
 
 **NodeJS**
 
 ```
-/home/ricmoo/some_project> npm install quais
+/home/some_project> npm install quais
 ```
 
 **Browser (ESM)**
@@ -84,11 +69,11 @@ For developers looking to contribute to quais or integrate it into their project
 
 2. Install dependencies.
 
-    ``` bash
+    ```bash
     npm install
     ```
 
-3. Create a global symbolic link for quais. This makes the quais package available to link in any other project. Whenever a local change is made to quais that you want to test in another project, you must run this command again to update the symbolic link. 
+3. Create a global symbolic link for quais. This makes the quais package available to link in any other project. Whenever a local change is made to quais that you want to test in another project, you must run this command again to update the symbolic link.
 
     ```bash
     npm run update-symlink
@@ -109,7 +94,7 @@ After setting up quais for local development, you can link it to another project
     npm link quais
     ```
 3. Build your project: Depending on your project's setup, you may need to rebuild it to ensure that the linked quais library is correctly integrated.
-npm run build
+   npm run build
 
 **Testing Changes**
 
@@ -118,7 +103,9 @@ With quais linked to your project, any changes made to the quais library can be
 **Reverting to the Published Package**
 
 If you need to revert back to the official quais package published on npm, you can unlink quais and reinstall the package.
+
 1. Unlink quais by removing the symlink.
+
     ```bash
     npm unlink quais
     ```
@@ -130,49 +117,19 @@ If you need to revert back to the official quais package published on npm, you c
 
 ## Documentation
 
-Browse the [documentation](https://docs.quais.org) online:
-
-- [Getting Started](https://docs.quais.org/v6/getting-started/)
-- [Full API Documentation](https://docs.quais.org/v6/api/)
-- [Various Ethereum Articles](https://blog.ricmoo.com/)
-
-## Providers
-
-quais works closely with an ever-growing list of third-party providers
-to ensure getting started is quick and easy, by providing default keys
-to each service.
-
-These built-in keys mean you can use `quais.getDefaultProvider()` and
-start developing right away.
-
-However, the API keys provided to quais are also shared and are
-intentionally throttled to encourage developers to eventually get
-their own keys, which unlock many other features, such as faster
-responses, more capacity, analytics and other features like archival
-data.
-
-When you are ready to sign up and start using for your own keys, please
-check out the [Provider API Keys](https://docs.quais.org/v5/api-keys/) in
-the documentation.
-
-A special thanks to these services for providing community resources:
+Documentation for the Quais SDK is under construction and will be available soon. In the meantime, please refer to the reference material below:
 
-- [Ankr](https://www.ankr.com/)
-- [QuickNode](https://www.quicknode.com/)
-- [quaiscan](https://quaiscan.io/)
-- [INFURA](https://infura.io/)
-- [Alchemy](https://dashboard.alchemyapi.io/signup?referral=55a35117-028e-4b7c-9e47-e275ad0acc6d)
+-   [Ethers V6 Documentation](https://docs.ethers.io/v6/)
+-   [Quai Network JSON RPC Docs](https://qu.ai/docs/develop/apis/json-rpc-api/)
 
 ## Extension Packages
 
 The `quais` package only includes the most common and most core
-functionality to interact with Ethereum. There are many other
+functionality to interact with Quai Network. There are many other
 packages designed to further enhance the functionality and experience.
 
-- [MulticallProvider](https://github.com/quais-io/ext-provider-multicall) - A Provider which bundles multiple call requests into a single `call` to reduce latency and backend request capacity
-- [GanaceProvider](https://github.com/quais-io/ext-provider-ganache) - A Provider for in-memory node instances, for fast debugging, testing and simulating blockchain operations
-- [Optimism Utilities](https://github.com/quais-io/ext-utils-optimism) - A collection of Optimism utilities
-- [LedgerSigner](https://github.com/quais-io/ext-signer-ledger) - A Signer to interact directly with Ledger Hardware Wallets
+-   [QuaisPolling](https://npmjs.com/package/quais-polling) - A package to poll Quai Network for events and logs
+-   [MulticallProvider](https://github.com/ethers-io/ext-provider-multicall) - A Provider which bundles multiple call requests into a single `call` to reduce latency and backend request capacity
 
 ## License