Skip to content

Commit

Permalink
Updated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
miohtama committed Mar 30, 2017
1 parent e0ff4cf commit 75e9329
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 4 deletions.
13 changes: 12 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This package contains Ethereum smart contracts and Python based command line tools for launching your `ICO <https://tokenmarket.net/what-is/ico>`_ crowdsale or token offering.
This package contains Ethereum smart contracts and Python based command line tools for launching your ICO crowdsale or token offering.

.. image:: https://img.shields.io/pypi/v/ico.svg
:target: https://pypi.python.org/pypi/ico
Expand All @@ -12,9 +12,20 @@ This package contains Ethereum smart contracts and Python based command line too

.. contents:: :local:

Links
=====

`Github issue tracker and source code <https://github.com/tokenmarketnet/ico>`_

`Documentation <https://ico.readthedocs.io/en/latest/>`_

About the project
=================

`ICO stands for a token or cryptocurrency initial offering crowdsale <https://tokenmarket.net/what-is/ico>`_. It is a common method in blockchain space, decentralized applications and in-game tokens for bootstrap funding of your project.

This project aims to provide standard, secure smart contracts and tools to create crowdsales for Ethereum blockchain.

As the writing of this, Ethereum smart contract ICO business has been booming almost a year. The industry and development teams are still figuring out the best practices. A lot of similar smart contracts get written over and over again. This project aims to tackle this problem by providing reusable ICO codebase, so that developers can focus on their own project specific value adding feature instead of rebuilding core crowdfunding logic. Having one well maintained codebase with best practice and security audits benefits the community as a whole.

This package provides
Expand Down
32 changes: 32 additions & 0 deletions docs/source/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{% extends '!layout.html' %}

{%- block footer %}
<div class="footer">
{% if show_copyright %}&copy;{{ copyright }}, <a href="https://tokenmarket.net">TokenMarket Ltd.</a>{% endif %}
</div>

{% if theme_github_banner|lower != 'false' %}
<a href="https://github.com/{{ theme_github_user }}/{{ theme_github_repo }}" class="github">
<img style="position: absolute; top: 0; right: 0; border: 0;" src="{{ pathto('_static/' ~ theme_github_banner, 1) if theme_github_banner|lower != 'true' else 'https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png' }}" alt="Fork me on GitHub" class="github"/>
</a>
{% endif %}

{% if theme_analytics_id %}
<script type="text/javascript">

var _gaq = _gaq || [];
_gaq.push(['_setAccount', '{{ theme_analytics_id }}']);
_gaq.push(['_setDomainName', 'none']);
_gaq.push(['_setAllowLinker', true]);
_gaq.push(['_trackPageview']);

(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();

</script>
{% endif %}
{%- endblock %}

10 changes: 7 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,14 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
ICO smart contracts and tool documentation
ICO smart contract and tool documentation
==========================================

This package contains Ethereum smart contracts and Python based command line tools for launching your `ICO <https://tokenmarket.net/what-is/ico>`_ crowdsale or token offering.
This is a documentation for `ICO package <https://github.com/tokenmarketnet/ico>`_ providing Ethereum smart contracts and Python based command line tools for launching your `ICO <https://tokenmarket.net/what-is/ico>`_ crowdsale or token offering.

`ICO stands for a token or cryptocurrency initial offering crowdsale <https://tokenmarket.net/what-is/ico>`_. It is a common method in blockchain space, decentralized applications and in-game tokens for bootstrap funding of your project.

This project aims to provide standard, secure smart contracts and tools to create crowdsales for Ethereum blockchain.

.. toctree::
:maxdepth: 1
Expand All @@ -24,4 +28,4 @@ Links

`Github issue tracker and source code <https://github.com/tokenmarketnet/ico>`_

`Documentation <https://github.com/tokenmarketnet/ico>`_
`Documentation <https://ico.readthedocs.io/en/latest/>`_
4 changes: 4 additions & 0 deletions docs/source/support.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Commercial support
==================

Contact `TokenMarket for launching your ICO or crowdsale <https://tokenmarket.net/ico-professional-services>`_

0 comments on commit 75e9329

Please sign in to comment.