Update README.md

Author: mikirov

README.md

@@ -2,29 +2,52 @@
 
 A plugin for handling Polkadot blockchain operations, providing wallet management and price fetching capabilities.
 
-### Usage
----
-Add the plugin to your character configuration:
-
-```
-"plugins": ["@elizaos-plugins/plugin-polkadot"]
-```
-## Configuration
-The plugin requires these environment variables (can be set in .env file or character settings):
+## Step by Step Usage
+
+**Option 1** - Dynamically Loading from Github repo:
+1. Follow the ElizaOS quickstart instructions here: https://eliza.how/docs/quickstart
+2. Add the following dependancy in your newly created agent's package.json: `"@esscrypt/plugin-polkadot": "github:Esscrypt/plugin-polkadot"`
+3. Add the following line to the end of the plugins array in src/character.ts: `'@esscrypt/plugin-polkadot'`
+4. Run: `bun install`
+5. Start Agent: `bun run dev` 
+6. (Optional) Set root .env with **POLKADOT_PRIVATE_KEY** and **POLKADOT_RPC_URL**
+> Note: When starting the Agent, if **POLKADOT_PRIVATE_KEY** is not set, an error will pop up, but the agent will still run and expect a wallet to get created by the user
+
+**Option 2** - Submodule
+1. Clone the ElizaOS monorepo: https://github.com/elizaOS/eliza
+2. Inside packages, clone the polkadot-plugin repo: https://github.com/Esscrypt/plugin-polkadot
+3. Configuration. Ether:
+- Inside `packages/plugin-polkadot/characters/polkadot.character.json`, Fill up the secrets:
 ```env
 "settings": {
-  "POLKADOT_RPC_URL": "rpc-url",
-  "COINMARKETCAP_API_KEY": "<api-key>",
-  "POLKADOT_PRIVATE_KEY": "<private_key>"
+    "secrets": {
+        "POLKADOT_RPC_URL": "<your-rpc-url>",
+        "POLKADOT_PRIVATE_KEY": "<your-private-key>",
+        "COINMARKETCAP_API_KEY": "<api-key>",
+        "OPENAI_API_KEY": "<your-openai-api-key>"
+    
+    }
 }
 ```
-Or in .env file:
+- Or in .env file:
 
 ```env
 POLKADOT_RPC_URL=your_polkadot_rpc_endpoint  # Optional - defaults to wss://rpc.polkadot.io
 COINMARKETCAP_API_KEY=your_cmc_api_key     # Optional - for fetching token prices
 POLKADOT_PRIVATE_KEY=your_mnemonic_phrase  # Optional - for default wallet initialization via initWalletProvider
+OPENAI_API_KEY=your-openai-api-key>       # Optional - for inference through the OpenAI LLM. You can use a different one
 ```
+4. In the root folder (monorepo), run:
+`bun i && bun run build`
+5. Eliza now supports a CLI that can be run through:
+```
+bun install -g @elizaos/cli
+elizaos start --character "packages/plugin-polkadot/characters/polkadot.character.json"
+# Alternatively using bun:
+bun run start:debug --character "packages/plugin-polkadot/characters/polkadot.character.json"
+```
+
+#### Go to [http://localhost:3000/](http://localhost:3000/) and interact with the agent. If started, click the "Polkadot" character and then "Start agent" then interact.
 
 ## Overview