Add quickstart tutorial

Author: cffls

.github/workflows/publish.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.7, 3.8, 3.9, '3.10']
+        python-version: [3.9]
         os: [ubuntu-latest]
     runs-on: ${{ matrix.os }}
     steps:

README.md

@@ -1,12 +1,13 @@
 ## PyCardano
 
+[![PyPi version](https://badgen.net/pypi/v/pycardano)](https://pypi.python.org/pypi/pycardano/)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/pycardano)](https://pypi.python.org/pypi/pycardano/)
+[![PyPi license](https://badgen.net/pypi/license/pycardano)](https://pypi.python.org/pypi/pycardano/)
+
 [![PyCardano](https://github.com/cffls/pycardano/actions/workflows/main.yml/badge.svg)](https://github.com/cffls/pycardano/actions/workflows/main.yml)
 [![codecov](https://codecov.io/gh/cffls/pycardano/branch/main/graph/badge.svg?token=62N0IL9IMQ)](https://codecov.io/gh/cffls/pycardano)
 [![Documentation Status](https://readthedocs.org/projects/pycardano/badge/?version=latest)](https://pycardano.readthedocs.io/en/latest/?badge=latest)
 
-[![Linux](https://svgshare.com/i/Zhy.svg)](https://svgshare.com/i/Zhy.svg)
-[![macOS](https://svgshare.com/i/ZjP.svg)](https://svgshare.com/i/ZjP.svg)
-
 
 PyCardano is a Cardano library written in Python. It allows users to create and sign transactions without 
 depending on third-party Cardano serialization tools, such as
@@ -23,9 +24,9 @@ could be beneficial for faster R&D iterations.
 - [PyCardano](#pycardano)
   - [Features](#features)
   - [Installation](#installation)
+  - [Documentation](#documentation)
   - [Examples](#examples)
     - [Transaction creation and signing](#transaction-creation-and-signing)
-  - [Documentations](#documentations)
   - [Development](#development)
     - [Workspace setup](#workspace-setup)
     - [Test](#test)
@@ -56,7 +57,13 @@ could be beneficial for faster R&D iterations.
 
 ### Installation
 
-The library is still under development. The first release will be published to PyPI soon.
+Install the library using [pip](https://pip.pypa.io/en/stable/):
+
+`pip install pycardano`
+
+### Documentation
+
+https://pycardano.readthedocs.io/en/latest/
 
 ### Examples
 
@@ -151,10 +158,6 @@ context.submit_tx(signed_tx.to_cbor())
 
 See more usages under [examples](https://github.com/cffls/pycardano/tree/main/examples).
 
-### Documentations
-
-https://pycardano.readthedocs.io/en/latest/
-
 
 -----------------
 

docs/source/index.rst

@@ -10,6 +10,12 @@ PyCardano is a standalone Cardano client written in Python. The library is able
 without depending on third-party Cardano serialization tools, such as cardano-cli and cardano-serialization-lib,
 making it a light-weight library that is easy and fast to set up in all kinds of environments.
 
+.. toctree::
+    :maxdepth: 1
+    :caption: Get Started
+
+    tutorial
+
 .. toctree::
     :maxdepth: 1
     :caption: Usage Guides

docs/source/tutorial.rst

@@ -0,0 +1,40 @@
+==========
+Quickstart
+==========
+
+------------
+Installation
+------------
+
+PyCardano could be installed using ``pip`` as follows:
+
+.. code-block:: shell
+
+   $ pip install pycardano
+
+
+---------------
+Using PyCardano
+---------------
+
+Create a payment key and a payment address::
+
+    >>> from pycardano import Address, Network, PaymentSigningKey, PaymentVerificationKey
+
+    >>> payment_signing_key = PaymentSigningKey.generate()
+    >>> payment_signing_key.save("payment.skey")
+    >>> payment_verification_key = PaymentVerificationKey.from_signing_key(payment_signing_key)
+    >>> payment_verification_key.save("payment.vkey")
+
+    >>> network = Network.TESTNET
+    >>> address = Address(payment_part=payment_verification_key.hash(), network=network)
+    >>> address
+    'addr_test1vr2p8st5t5cxqglyjky7vk98k7jtfhdpvhl4e97cezuhn0cqcexl7'
+
+
+Fund the address with some tADA (test ADA) through the
+`faucet <https://testnets.cardano.org/en/testnets/cardano/tools/faucet/>`_ here.
+
+With the address and key created above, you can now create and sign transactions, and submit the
+transaction to Cardano network. `Transaction usage guide <guides/transaction.html>`_ provides detailed steps about
+transaction creation and signing.