Skip to content
This repository has been archived by the owner on Mar 8, 2020. It is now read-only.

Properly explain what is "getting-started" in main README and correct 'info.js' instruction #81

Merged
merged 2 commits into from
Aug 17, 2017
Merged

Properly explain what is "getting-started" in main README and correct 'info.js' instruction #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ae13b7
Running info.js instruction requires a [prior] npm install
Aug 16, 2017
a66438e
Updated README.md to better explain 'getting started'
Aug 16, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,17 @@

The repository contains sample applications written against the [Hyperledger Composer](https://hyperledger.github.io/composer/)

Currently this contains the code and scripts for the ['DigitalProperty-App'](./packages/digitalproperty-app/README.md) tutorial.
Currently this contains the code and scripts for the ['DigitalProperty-App'](./packages/digitalproperty-app/README.md) tutorial - see the README in that directory for instructions on how to install.

To install this repo and find out more about the sample applications, run (from this directory):
```

npm install
node info.js

```


We welcome Pull Requests for new applications - please see the [contributing notes](https://github.com/hyperledger/composer/blob/master/CONTRIBUTING.md).

*IMPORTANT NOTE* The Getting Started application is the main route for people to get started with Hyperledger Composer - please exercise care when changing it!
*IMPORTANT NOTE* The Digital Property ("getting-started") sample CLI-based application is the main route for people to get started with Hyperledger Composer - please exercise care when changing it!
5 changes: 2 additions & 3 deletions packages/digitalproperty-app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ This diagram should to clarify the order in which the scripts can be run.
![](CmdOrder.png).


# Step 2: Getting the Hyperledger Composer sample application (digital property sample) up and running
# Step 2: Getting the Hyperledger Composer sample application (the Digital Property CLI sample application) up and running

0. Make sure you've started Fabric as in Step 1 above. For example, If this is your first time for example

Expand All @@ -113,8 +113,7 @@ $ cd composer-sample-applications
$
```

To see a summary of all the sample applications, there's a simple command that will show summary details of the applications
A useful information node.js script has been created to show the available sample applications
OPTIONAL: To see a summary of all the sample applications, there's a simple command that will show summary details of the sample applications available in this repository. A useful information node.js script has been created to show the available sample applications - note you will need to run `npm install` from the current directory (takes about 5-10 mins) before running this command.
```
$ node ~/github/composer-sample-applications/info.js
```
Expand Down