diff --git a/README.md b/README.md index 40b9eae..3b967d2 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,14 @@ -

- ⚠️ EthDoc is still a work in progress and has not yet had a V1 release. The instructions below still don't work! ⚠️ -

+![](https://i.imgur.com/zLHQchL.png) -
-

- -

+> ⚠️This tool is in **alpha** and has not yet been officially released. The instructions below will not work -

- Automatically generate beautiful documentation for your Ethereum smart contracts. -
-
- ETHDoc -

+Automatically generate beautiful documentation for your Ethereum (`.sol`) smart contracts. -This repository contains the source code for the frontend portion of [**EthDoc**](https://ethdoc.io). An Open Source developer tool that generates documentation for Smart Contracts using [Ethereum Natural Specification Format](https://github.com/ethereum/wiki/wiki/Ethereum-Natural-Specification-Format). The project is split into two parts, the [CLI](https://github.com/iMuzz/ethdoc-cli) and frontend (the repo you're currently on). +> This repository contains source code for the **frontend** of [**Ethdoc**](https://ethdoc.io), an open-source developer tool to generate documentation for Solidity smart contracts using the [Ethereum Natural Specification Format](https://github.com/ethereum/wiki/wiki/Ethereum-Natural-Specification-Format). To find the **CLI**, please visit the [other repo](https://github.com/iMuzz/ethdoc-cli). -
- -## Getting Started -The easiest way to get started with EthDoc is through the [CLI](https://github.com/iMuzz/ethdoc-cli). Follow the instructions below to get started! +### Getting Started +The easiest way to get started with Ethdoc is through the [CLI](https://github.com/iMuzz/ethdoc-cli). Follow the instructions below to get started! ##### 1. Install NPM Package ``` @@ -32,7 +20,7 @@ $ npm install ethdoc --save ``` $ ethdoc init ``` -This may take a few minutes. You only have to run this command the first time you integrate EthDoc into an Ethereum Project. +This may take a few minutes. You only have to run this command the first time you integrate Ethdoc into an Ethereum Project. ##### 3. Generate documentation @@ -47,13 +35,12 @@ $ ethdoc generate otherDirectory/ -s ##### 4. Check out your documentation -🎉 Navigate to http://localhost:3000 to check out your docs 🎉 +🎉 Navigate to `localhost:3000` to check out your docs 🎉 -
-## Development +### Development -EthDoc was built using [Next.js](https://github.com/zeit/next.js/) which is a framework created by the awesome people over at [Zeit](https://zeit.co/)! +Ethdoc is built using [Next.js](https://github.com/zeit/next.js/) which is a framework created by the incredible team at [ZEIT](https://zeit.co/). ##### 1. Install Dependencies ``` @@ -65,7 +52,11 @@ $ npm install $ npm run dev ``` -Navigate to http://localhost:3000 to see your changes. All changes are automatically reflected in the browser without having to refresh thanks to Next.js 😍 +Navigate to http://localhost:3000 to see your changes. All changes are automatically reflected in the browser without having to refresh, thanks to [Next.js](https://nextjs.org)! 😍 + +### Contributors +- Faraaz Nishtar ([iMuzz](https://github.com/iMuzz)) +- Achal Srinivasan ([achalvs](https://github.com/achalvs)) -## License +### License [MIT](https://github.com/iMuzz/ethdoc/blob/master/LICENSE)