Skip to content

Commit

Permalink
improve and simplify README
Browse files Browse the repository at this point in the history
  • Loading branch information
dhh1128 committed Jul 14, 2017
1 parent eab3bfb commit f610481
Showing 1 changed file with 1 addition and 34 deletions.
35 changes: 1 addition & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ with a different network, using whatever conventions a community chooses.
Bugs, stories, and backlog for this codebase are managed in [Hyperledger's Jira](https://jira.hyperledger.org).
Use project name INDY.

Join us on [Jira's Rocket.Chat](chat.hyperledger.org) at #indy to discuss
Join us on [Jira's Rocket.Chat](chat.hyperledger.org) at #indy to discuss.

Today, documentation for Indy is sparse. Most materials that exist were written for Sovrin. Therefore,
we recommend that developers should explore Sovrin's [Getting Started Guide](https://github.com/sovrin-foundation/sovrin-client/blob/master/getting-started.md) to learn about Indy Node basics. In the future, documentation
Expand All @@ -27,36 +27,3 @@ to understand how to work with the code. Note that setup instructions are
still changing hour-by-hour as we identify
install preconditions.

# Indy Client

[![Build Status](https://jenkins.evernym.com/buildStatus/icon?job=Sovrin%20Client/master)](https://jenkins.evernym.com/job/Sovrin%20Client/job/master/)

Indy Client provides a command-line tool and underlying interfaces to interact with
a [self-sovereign identity](https://sovrin.org) ecosystem on top of distributed ledger technology.
This codebase will eventually be subsumed by (Indy SDK)[https://github.com/hyperledger/indy-sdk);
if you are looking to build a client or agent, we recommend that you use the SDK instead, because
the encapsulation and documentation here are not as clean.

[Indy Node](https://github.com/hyperledger/indy-node) is more "core" to Indy; if you want to
understand how Indy works, starting there may be better.

All bugs, backlog, and stories for Indy (except the SDK) are managed in [Hyperledger's Jira](https://jira.hyperledger.org); use project name INDY.

Developers may want to explore Sovrin's [Getting Started Guide](https://github.com/sovrin-foundation/sovrin-client/blob/master/getting-started.md) to learn about how Indy works. (Sovrin is the public, open ecosystem
built on top of Indy technology; for more info, see [https://sovrin.org].)

Have a look at [Setup Instructions](https://github.com/sovrin-foundation/sovrin-client/blob/master/setup.md)
to understand how to work with the code. Note that setup instructions are still changing hour-by-hour as we identify install preconditions.

# Indy Common

[![Build Status](https://jenkins.evernym.com/buildStatus/icon?job=Sovrin%20Common/master)](https://jenkins.evernym.com/view/Core/job/Sovrin%20Common/job/master/)

Common utility functions for other Indy repos (like indy-client, indy-node etc)

This repo will be merged with indy-node at some point soon.

All bugs, backlog, and stories for this repo are managed in [Hyperledger's Jira](https://jira.hyperledger.org).

Join us on [Jira's Rocket.Chat](chat.hyperledger.org) at #indy to discuss.

0 comments on commit f610481

Please sign in to comment.