Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
ashcherbakov Merge pull request #190 from andkononykhin/ST-610-pin-token-plugins-i…
…n-master

[ST-610] Pins token plugins as dependencies for master
Latest commit 54f99dc Jul 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
TAA Rename AML.json to AML.md Jun 25, 2019
build-scripts/ubuntu-1604
collateral tweak README and add logos Jul 31, 2017
docs fixed link in index.rst Jun 24, 2019
sovrin Update the genesis file, following the removal of many nodes that May 16, 2019
spec -s May 3, 2019
.flake8 Adhere PEP8 (#18) Aug 18, 2017
.gitignore
Jenkinsfile set fixed version of jenkins library to 1.2.1 Apr 25, 2019
LICENSE Feature/indy 399 (#2) Jul 13, 2017
MANIFEST.in Feature Added: Sovrin package support Jul 13, 2017
README.md
_config.yml Set theme jekyll-theme-hacker Nov 28, 2017
banner.png INDY-456 Sovrin Release Notes - Aries 1.0 Jul 30, 2017
conf.py
release-notes.md
setup.py removes pins for all deps in master Jul 16, 2019

README.md

logo

The Sovrin Foundation

Sovrin is a global utility for self-sovereign identity--that is, an identity that nobody controls except its natural owner, that can't be taken away or stripped of its privacy or manipulated through unreasonable terms of service. Imagine if you could bring your identity with you to all your digital interactions, instead of creating new logins for every online bank, every mobile app, every social network every email client, every government agency, every shopping site... Imagine if they logged in to you, instead of the other way around... Sovrin uses distributed ledger (blockchain) technology to achieve this freedom, and it leverages very sophisticated cryptography to make it all secure and private.

Sovrin's technical underpinnings come from Hyperledger's Indy project.

Sovrin is a specific instantiation of Indy, using a governance framework as the legal foundation of the Sovrin Network. The Sovrin Foundation provides the business, legal, and technical support for the Sovrin Network as a transparent and neutral party.

The code that's stored here operates as a thin veneer on top of Indy--just enough to provide genesis transactions for the particular machines that bootstrapp Sovrin, plus some light utilities for those who run Sovrin as stewards.

To interact with the vibrant 1,000+ member Sovrin community, visit us on our Rocket Chat forum. If you are a developer, please join the Hyperledger Indy community forum to learn and build together. We're happy to have you here.

To report vulnerabilities against Sovrin, please email security@sovrin.org or visit us on hackerone.

If you'd like to use Sovrin's identity toolset in your system, we recommend that you first check out the indy-sdk; it offers a C-callable library plus convenience wrappers in java, python, .NET, and more. Documentation is currently light, but the API is liberally commented.

We have an ongoing effort to create interoperable Sovrin agents that work well together. This is being accomplished in the indy-agent repository and, more recently, the Hyperledger Aries project

You may also want to work through Indy's Getting Started Guide.

If you want to contribute to Sovrin, it's likely that you'll want to do so via indy-node. You can view additional bugs, stories, and backlog for Indy in Hyperledger's Jira. Use project name INDY (or IS for the Indy SDK).

How to Add Documentation

For new features and pull requests, maintainers should make sure that the contributor has added an explanation for their changes in the docs folder before merging the PR.

Contributors should write an addition to a current file or add a new file to the docs/source/ folder that explains what their feature is and how it works. If needed, they may also add a link to more technical README's located nearer to the code.

Whenever additions are made to the docs, make sure to update the index.rst in whichever folder the file has been added, and build the docs locally to confirm they work (TODO: add the sphinx-build command to our CI/CD flow).

For example, if I wanted to add another file to the indy-sdk docs/ folder named glossary.md, I would create the file, and then add a reference to it in the index.rst:

.. toctree::
  :maxdepth: 1
  :hidden:

  getting-started/index.rst
  ...
  other files
  ...
  glossary.md                   .. <-- this is your new file!

To add a new file to a subfolder, simply update the subfolder's index.rst with the relative link to your file.

If you'd like to link to a file outside of the docs/ folder, you'll need to provide an external github link (this is by design, to keep our docs organized into a single folder)

Building the docs on your machine

Here are the quick steps to achieve this on a local machine without depending on ReadTheDocs. Note: Instructions may differ depending on your OS. Run these commands within the repository folder

pip install Sphinx
pip install sphinx_rtd_theme
pip install recommonmark==0.4.0
make html

This will generate all the html files in _build/html which you can then browse locally in your browser. Every time you make a change to the documentation you will need to rerun make html.

Additional Instructions

This section is to be used for repo maintainers to add additional documentation guidelines or instructions.

You can’t perform that action at this time.