docs(readme): include getting started instructions #20
Conversation
There was a problem hiding this comment.
@tk-o Hey so happy to see this! Reviewed and shared feedback 👍 Let's make this getting started amazing 💪
There was a problem hiding this comment.
@tk-o Thanks for your updates 👍 Reviewed and shared feedback 😄
Co-authored-by: lightwalker.eth <[email protected]>
There was a problem hiding this comment.
@tk-o Hey, this PR is a couple of weeks old now. Let's please get this PR ready to be successfully merged. To help speed up the completion of this PR I transferred most of the open goals into a separate issue #42 and assigned next steps on that issue to @BanaSeba. However, @tk-o, we still need your help to fix up and resolve the remaining open issues that are flagged on this PR. Let's please get this ready for merge as soon as we can. Thanks.
README.md
Outdated
| Clone this repository: | ||
| ``` | ||
| git clone [email protected]:namehash/ens-multichain-indexer.git | ||
| cd ens-multichain-indexer |
There was a problem hiding this comment.
Please update these to ensnode now that we've renamed.
README.md
Outdated
| ``` | ||
| then review the docs inside your .env.local file for configuration instructions. | ||
|
|
||
| - `ACTIVE_PLUGIN` — set the plugin name you’d like to activate (`eth`, `base.eth`, or `linea.eth`). The activated plugin determines which contracts and chains are indexed. Currently only a single plugin can be activated at a time. Soon we will remove this constraint to allow multiple plugins to be activated concurrently. |
There was a problem hiding this comment.
Please update all plugin related docs now that we are using ACTIVE_PLUGINS and support 1 or more active plugins.
README.md
Outdated
|
|
||
| ## Overview | ||
|
|
||
| ### `eth` plugin |
There was a problem hiding this comment.
Please carefully review the whole structure of this file to ensure no merge conflicts and that it all will read naturally once we merge it into main.
tk-o
force-pushed
the
docs/getting-started
branch
from
41becf4 to
82ca8e9
Compare
Allow new users to run indexer locally for a selected active plugin.