diff --git a/docs/source/_static/kapow-quick-overview.png b/docs/source/_static/kapow-quick-overview.png new file mode 100644 index 0000000..8262c51 Binary files /dev/null and b/docs/source/_static/kapow-quick-overview.png differ diff --git a/docs/source/index.rst b/docs/source/index.rst index 7dab6da..8b50c47 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,16 +1,60 @@ -.. toctree:: - :maxdepth: 2 - :caption: Setup +Welcome to Kapow! +================= - setup/install-and-configure +.. image:: https://circleci.com/gh/BBVA/kapow/tree/master.svg?style=svg + :target: https://circleci.com/gh/BBVA/kapow/tree/master +.. image:: https://goreportcard.com/badge/github.com/bbva/kapow + :target: https://goreportcard.com/report/github.com/bbva/kapow +.. image:: https://img.shields.io/github/issues/BBVA/kapow + :target: https://github.com/BBVA/kapow/issues/ +.. image:: https://img.shields.io/github/v/release/BBVA/kapow?include_prereleases + :target: https://github.com/BBVA/kapow/releases + +**If you can script it, you can HTTP it** + +What's Kapow! +============= + +Think in this **software** that you need but **only can runs in command line**. Kapow! lets you to **wrap it into an HTTP API without write any line of code**. + +.. image:: _static/kapow-quick-overview.png + :width: 80% + :align: center + +Want to know more? Check the :doc:`the_project/overview` section for a long explanation of what Kapow! does. + +Authors +======= + +**Kapow!** is being developed by `BBVA-Labs Security team members `_. + +License +======= + +**Kapow!** is Open Source Software and available under the `Apache 2 license `_. + + +Contributions +============= + +Contributions are of course welcome. See `CONTRIBUTING `_ or skim existing tickets to see where you could help out. + +Table of content +================ .. toctree:: :maxdepth: 2 - :caption: Examples + :caption: The Project + + the_project/overview + the_project/quickstart + the_project/install-and-configure + +.. toctree:: + :maxdepth: 2 + :caption: Usage examples examples/index - examples/greet-json - examples/upload .. toctree:: :maxdepth: 2 diff --git a/docs/source/setup/install-and-configure.rst b/docs/source/the_project/install-and-configure.rst similarity index 99% rename from docs/source/setup/install-and-configure.rst rename to docs/source/the_project/install-and-configure.rst index 8a1ec37..677327d 100644 --- a/docs/source/setup/install-and-configure.rst +++ b/docs/source/the_project/install-and-configure.rst @@ -3,7 +3,7 @@ Installing Kapow! Kapow! has a reference implementation in Go that is under active development right now. If you want to start using Kapow! you can choose from several -options +options. Download and install a binary diff --git a/docs/source/the_project/quickstart.rst b/docs/source/the_project/quickstart.rst new file mode 100644 index 0000000..37f4c0b --- /dev/null +++ b/docs/source/the_project/quickstart.rst @@ -0,0 +1,2 @@ +Quick start +=========== \ No newline at end of file