From 1bf760555f89d7cd077cc9b06dbb0491359681cd Mon Sep 17 00:00:00 2001
From: El De-dog-lo <3859395+fubuloubu@users.noreply.github.com>
Date: Tue, 27 Apr 2021 23:52:39 -0400
Subject: [PATCH] docs: update readme for users

---
 README.md | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)

diff --git a/README.md b/README.md
index 2998470a95..54c60b0c8d 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,80 @@
 # Ape Framework
+
+Ape is a framework for Web3 Python applications and smart contracts, with advanced functionality for testing, deployment, and on-chain interactions.
+
+## Dependencies
+
+* [python3](https://www.python.org/downloads) version 3.6 or greater, python3-dev
+
+## Installation
+
+### via `pip`
+
+You can install the latest release via [`pip`](https://pypi.org/project/pip/):
+
+```bash
+pip install eth-ape
+```
+
+### via `setuptools`
+
+You can clone the repository and use [`setuptools`](https://github.com/pypa/setuptools) for the most up-to-date version:
+
+```bash
+git clone https://github.com/ApeWorX/ape.git
+cd ape
+python3 setup.py install
+```
+
+## Quick Usage
+
+Ape is primarily meant to be used as a command line tool. Here are some things you can use ape to do:
+
+```bash
+# Work with your accounts
+$ ape accounts list
+
+# Compile your project's smart contracts
+$ ape compile --size
+
+# Run your tests with pytest
+$ ape test -k test_only_one_thing --coverage --gas
+
+# Connect an IPython session through your favorite provider
+$ ape console --network ethereum:mainnet:infura
+
+# Add new plugins to ape
+$ ape plugins add plugin-name
+```
+
+Ape also works as a package. You can use the same networks, accounts, and projects from the ape package as you can in the cli:
+
+```python
+# Work with registered networks, providers, and blockchain ecosystems (like Ethereum)
+from ape import networks
+with networks.ethereum.mainnet.use_provider("infura"):
+    ...  # Work with the infura provider here
+
+# Work with test accounts, local accounts, and (WIP) popular hardware wallets
+from ape import accounts
+a = accounts[0]  # Load by index
+a = accounts["example.eth"]  # or load by ENS/address
+a = accounts.load("alias") # or load by alias
+
+# Work with contract types
+from ape import project
+c = a.deploy(project.MyContract, ...)
+c.viewThis()  # Make Web3 calls
+c.doThat({"from": a})  # Make Web3 transactions
+assert c.MyEvent[-1].caller == a  # Search through Web3 events
+```
+
+## Development
+
+This project is in early development and should be considered an alpha.
+Things might not work, breaking changes are likely.
+Comments, questions, criticisms and pull requests are welcomed.
+
+## License
+
+This project is licensed under the [Apache 2.0](LICENSE).