Merge pull request #113 from opentensor/rajk/README-revision

Revising README

Author: Watchmaker

README.md

@@ -1,3 +1,143 @@
-# btcli
+<div align="center">
 
-This is pre-release of the new btcli. If you stumbled upon this, you are probably looking for the current btcli which is part of https://github.com/opentensor/bittensor
+# Bittensor CLI <!-- omit in toc -->
+[![Discord Chat](https://img.shields.io/discord/308323056592486420.svg)](https://discord.gg/bittensor)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) 
+<!-- [![PyPI version](https://badge.fury.io/py/bittensor_cli.svg)](https://badge.fury.io/py/bittensor_cli) -->
+
+---
+
+## Internet-scale Neural Networks <!-- omit in toc -->
+
+[SDK](https://github.com/opentensor/bittensor/tree/master) • [Wallet](https://github.com/opentensor/btwallet) • [Research](https://bittensor.com/whitepaper)
+
+</div>
+
+- [Documentation](#documentation)
+- [Install on macOS and Linux](#install-on-macos-and-linux)
+  - [Install from source](#install-from-source)
+- [Install on Windows](#install-on-windows)
+- [Verify the installation](#verify-the-installation)
+- [Configuration](#configuration)
+  - [Example config file](#example-config-file)
+- [License](#license)
+
+---
+
+The Bittensor CLI, `btcli`, is a powerful command line tool for the Bittensor platform. You can use it on any macOS, Linux or WSL terminal to manage all common operations like creating a wallet, registering a subnet or a neuron, delegating your TAO, viewing Senate proposals and voting for them, and much more. Help information can be invoked for every command and option with `--help` option.
+
+![btcli screenshot](./assets/btcli-screenshot.png)
+
+---
+
+## Documentation
+
+Installation steps are described below. For a full documentation on how to use `btcli`, see the [Bittensor CLI section](https://docs.bittensor.com/btcli) on the developer documentation site.
+
+---
+
+## Install on macOS and Linux
+
+You can install `btcli` on your local machine directly from source. **Make sure you verify your installation after you install**:
+
+### Install from source
+
+1. Create and activate a virtual environment.
+
+```bash
+python3 -m venv btcli_venv
+source btcli_venv/bin/activate
+```
+
+2. Clone the Bittensor CLI repo.
+
+```bash
+git clone https://github.com/opentensor/btcli.git
+```
+
+3. `cd` into `btcli` directory.
+
+```bash
+cd btcli
+```
+
+4.  Install
+
+
+```bash
+pip3 install .
+```
+
+---
+
+## Install on Windows
+
+To install and run Bittensor SDK on Windows you must install [**WSL 2** (Windows Subsystem for Linux)](https://learn.microsoft.com/en-us/windows/wsl/about) on Windows and select [Ubuntu Linux distribution](https://github.com/ubuntu/WSL/blob/main/docs/guides/install-ubuntu-wsl2.md). 
+
+After you installed the above, follow the same installation steps described above in [Install on macOS and Linux](#install-on-macos-and-linux).
+
+**ALERT**: **Limited support on Windows for Bittensor operations**
+While wallet transactions like delegating, transfer, registering, staking can be performed on a Windows machine using WSL 2, the subnet mining and subnet validating operations are not recommended and are not supported on Windows machines.
+
+---
+
+## Verify the installation
+
+```bash
+btcli --version
+```
+
+The above command will show you the version of the `btcli` you just installed.
+
+---
+
+## Configuration
+
+You can set the commonly used values, such as your hotkey and coldkey names, the default chain URL or the network name you use, and more, in `config.yml`. You can override these values by explicitly passing them in the command line for any `btcli` command.
+
+### Example config file
+
+The default location of the config file is: `~/.bittensor/config.yml`. An example of a `config.yml` is shown below:
+
+```yaml
+chain: ws://127.0.0.1:9945
+network: local
+no_cache: False
+wallet_hotkey: hotkey-user1
+wallet_name: coldkey-user1
+wallet_path: ~/.bittensor/wallets
+metagraph_cols:
+  ACTIVE: true
+  AXON: true
+  COLDKEY: true
+  CONSENSUS: true
+  DIVIDENDS: true
+  EMISSION: true
+  HOTKEY: true
+  INCENTIVE: true
+  RANK: true
+  STAKE: true
+  TRUST: true
+  UID: true
+  UPDATED: true
+  VAL: true
+  VTRUST: true
+```
+
+**For more help:**
+
+```bash
+btcli config --help
+```
+
+---
+
+## License
+The MIT License (MIT)
+Copyright © 2024 The Opentensor Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.