diff --git a/docs/source/overview.rst b/docs/source/overview.rst index 518ee13b6..24d894fac 100644 --- a/docs/source/overview.rst +++ b/docs/source/overview.rst @@ -2,37 +2,35 @@ Overview ======== -What does it currently do -^^^^^^^^^^^^^^^^^^^^^^^^^ - -- This project aims to be a full port of the original C# `NEO project `_ -- Run a Python based P2P node -- Interactive CLI for configuring node and inspecting blockchain -- Compile, test, deploy and run Smart Contracts written in python or any Smart Contract in the ``.avm`` format -- `NEP2 `_ and `NEP5 `_ compliant wallet functionality -- RPC Client -- RPC server -- Notification Server ( for viewing transfers of NEP5 tokens ) -- ``Runtime.Log`` and ``Runtime.Notify`` event monitoring - -What will it do -^^^^^^^^^^^^^^^ +Neo-python is an implementation of the Neo protocol using Python. + + +What it currently does +^^^^^^^^^^^^^^^^^^^^^^ -- Consensus nodes -- Full smart contract debugging and inspection +- A Command Line Interface (CLI) for node configuration and blockchain inspection. +- Smart Contracts development tool using `neo-boa `_, debugging and deployment using the command line. +- `RPC Client `_ and RPC Server. +- Notification server with optional REST endpoints (for viewing transfers of NEP5 tokens). +- ``Runtime.Log`` and ``Runtime.Notify`` event monitoring. +- `NEP2 `_ and `NEP5 `_ compliant wallet. +- This project aimed to be an alternative implementation for the original C# `NEO + project `_. + + +Neo 3 +^^^^^ +Our current focus is on Neo 3, with neo-python (Neo 2) only receiving the necessary bug fixes. Getting started ^^^^^^^^^^^^^^^ -Please follow directions in `the install section `_ +Please follow directions in `the install section `_. -The main functionality for this project is contained within the cli application ``np-prompt``. You can `view usage details here `_ +The main functionality for this project is contained within the cli application ``np-prompt``. You can `view usage details here `_. -We have published a Youtube `video `_ to help get you started with this library. There are other videos under the `CityOfZion <(https://www.youtube.com/channel/UCzlQUNLrRa8qJkz40G91iJg>`_ Youtube channel. +Watch this `video `_ to help get you started. -Sister projects -^^^^^^^^^^^^^^^ +Visit `CityOfZion `_ for more video tutorials. -- `neo-python-rpc `_: NEO RPC client in Python -- `neo-boa `_: Write smart contracts with Python