Skip to content

Commit

Permalink
updated documentation for credentials upload & query
Browse files Browse the repository at this point in the history
  • Loading branch information
Harsh Rathi committed Jan 8, 2019
1 parent 306e21c commit a19249f
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 2 deletions.
29 changes: 28 additions & 1 deletion EchoLinkDapp/docs/source/credentials_query.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,29 @@
Query Credentials
-----------------
-----------------

In this section of our application you can query the credentials you've uploaded on our network to the blockchain. The image below shows the screenshot of the page.

.. figure:: images/query_credentials.png
:alt: Credentials Query

Let's query the credentials which we uploaded in our previous section on :doc:`upload credentials <credentials_upload>`.

.. figure:: images/query_credentials_demo.png
:alt: Credentials Query Demo

Here you can see the demo of how you can retrive your credentials, data will be displayed when the correct status is entered.

.. figure:: images/query_credentials.gif
:alt: Credentials Query Demo

Here you can preview the image you've uploaded with your credentials and can download it in your local system. Also, Once you've done the transaction, you can see the history of the transactions with time and address by clicking on :code:`Show Transactions history` button.

View Credentials: User Profile
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can see on the demo above, there's :code:`view credential` option below the image you queried. Clicking on that will lead you to a new page which can serve as your public profile. You can access it anywhere without having to login.

The profile page will look like the one below.

.. figure:: images/view_credentials_demo.gif
:alt: View Credentials Demo
19 changes: 18 additions & 1 deletion EchoLinkDapp/docs/source/credentials_upload.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
Upload Credentials
------------------
------------------

This is page where you can upload your credentials to our network on blockchain.

.. figure:: images/submit_credentials.png
:alt: Credentials Submit

Let's add some data and upload the credentials

.. figure:: images/submit_credentials_demo.png
:alt: Credentials Submit

Here you can see the demo of how the transaction hash is generated for our transaction on the network. You can retrive the transaction hash and check the status on our node or the status of the transaction will be shown during the transaction as you'll see below.

.. figure:: images/submit_credentials_demo.gif
:alt: Credentials Submit

For a successful transaction, you need to have your account address approved by the admin and then have some token energy. You can see the token being energy updated at the top right corner with the successful transaction. Once you've done the transaction, you can see the history of the transactions with time and status by clicking on :code:`Show Transactions history` button. If any transaction fails, you'll have an option to resubmit that transaction without having to enter the credentials again. And if the transaction is successful, you'll see the the updated time and status in the transaction history table.

0 comments on commit a19249f

Please sign in to comment.