From a843a055b76223cfd00f996b836a105ab5ea77d4 Mon Sep 17 00:00:00 2001
From: J08nY
Date: Sun, 21 Apr 2019 18:09:34 +0200
Subject: Update readmes.

---
 README.md      | 13 +++++++++++--
 docs/index.rst | 16 ++++++++++++++++
 2 files changed, 27 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index abb032b..7a4decf 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,17 @@
 # ![](docs/_static/logo_black_small.png) pyecsca [pɪɛtska]
 
-[![Build Status](https://travis-ci.org/J08nY/pyecsca.svg?branch=master)](https://travis-ci.org/J08nY/pyecsca) ![License: MIT](https://img.shields.io/github/license/J08nY/pyecsca.svg) [![Codecov](https://img.shields.io/codecov/c/github/J08nY/pyecsca.svg)](https://codecov.io/gh/J08nY/pyecsca)
+[![Build Status](https://travis-ci.org/J08nY/pyecsca.svg?branch=master)](https://travis-ci.org/J08nY/pyecsca) [![docs](https://img.shields.io/badge/docs-neuromancer.sk-brightgreen.svg)](https://neuromancer.sk/pyecsca/)  ![License: MIT](https://img.shields.io/github/license/J08nY/pyecsca.svg) [![Codecov](https://img.shields.io/codecov/c/github/J08nY/pyecsca.svg)](https://codecov.io/gh/J08nY/pyecsca)
 
 **Py**thon **E**lliptic **C**urve cryptography **S**ide-**C**hannel **A**nalysis toolkit.
 
+## Functionality
+
+*pyecsca* aims to fill a gap in SCA tooling for Elliptic Curve Cryptography, it focuses on
+black-box implementations of ECC and presents a way to extract implementation information
+about a black-box implementation of ECC through side-channels. It is in an alpha stage of development
+and thus currently only provides basic trace processing capabilities (in the [*pyecsca.sca*](pyecsca/sca) package)
+and ECC simulation in the [*pyecsca.ec*](pyecsca/ec) package.
+
 ## Requirements
 
  - [Numpy](https://www.numpy.org/)
@@ -21,7 +29,8 @@ It also supports working with [Riscure](https://www.riscure.com) Inspector trace
 
  - [nose2](https://nose2.readthedocs.io)
  - [green](https://github.com/CleanCut/green)
- - [mypy](http://mypy-lang.org/)
+ - [mypy](http://mypy-lang.org/)
+ - [coverage](https://coverage.readthedocs.io/)
 
 ### Docs
 
diff --git a/docs/index.rst b/docs/index.rst
index f338fe9..fa5916e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -9,6 +9,16 @@ pyecsca [pɪɛtska]
 
 **Py**\ thon **E**\ lliptic **C**\ urve cryptography **S**\ ide-**C**\ hannel **A**\ nalysis toolkit.
 
+Functionality
+=============
+
+*pyecsca* aims to fill a gap in SCA tooling for Elliptic Curve Cryptography, it focuses on
+black-box implementations of ECC and presents a way to extract implementation information
+about a black-box implementation of ECC through side-channels. It is in an alpha stage of development
+and thus currently only provides basic trace processing capabilities (in the *pyecsca.sca* package)
+and ECC simulation in the *pyecsca.ec* package.
+
+
 API
 ===
 
@@ -37,11 +47,14 @@ Testing
 
  - nose2_
  - green_
+ - mypy_
+ - coverage_
 
 Docs
 ----
 
  - sphinx_
+ - sphinx-autodoc-typehints_
 
 License
 =======
@@ -78,6 +91,9 @@ this support is very appreciated.
 .. _fastdtw: https://github.com/slaypni/fastdtw
 .. _nose2: https://nose2.readthedocs.io
 .. _green: https://github.com/CleanCut/green
+.. _mypy: http://mypy-lang.org/
+.. _coverage: https://coverage.readthedocs.io/
 .. _sphinx: https://www.sphinx-doc.org/
+.. _sphinx-autodoc-typehints: https://pypi.org/project/sphinx-autodoc-typehints/
 .. _Explicit-Formulas Database: https://www.hyperelliptic.org/EFD/index.html
 .. _Riscure: https://www.riscure.com/
-- 
cgit v1.3.1