Update the README.md to reflect Grid (was: Sawtooth Supply Chain) #2

vaporos · 2019-01-17T22:43:07Z

Signed-off-by: Shawn T. Amundson amundson@bitwise.io

annechenette · 2019-01-17T22:47:04Z

README.md


-![Hyperledger Sawtooth](images/sawtooth_logo_light_blue-small.png)
+Grid is a WebAssembly-based project for building supply chain solutions. It


It's against best practices to turn a product name (a noun) into an hyphenated adjective (WebAssembly-based). Instead, I recommend "... a project based on WebAssembly for building...".

Also, consider adding a link to WebAssembly.org.

This was just pulled from the proposal. I removed WebAssembly-based, as it places too much of the emphasis on a specific underlying technology.

annechenette · 2019-01-17T22:53:55Z

README.md

-please see its
-[sawtooth-core repo](https://github.com/hyperledger/sawtooth-core) or its
-[published docs](https://sawtooth.hyperledger.org/docs/).
+Documentation for how to run and extend Grid is available here:


Change "here:" to "at" (without the colon).

(Best practice for online writing: Do not use "here" to introduce a link or act as the link text.)

Also, I suggest changing "Documentation for" to "Information on" (to avoid duplicating the word "Documentation).

annechenette · 2019-01-17T22:54:28Z

README.md

-  - [Manually Building Generated Files](#manually-building-generated-files)
- [Documentation](#documentation)
- [License](#license)
+This Hyperledger project is in _Incubation_. It was proposed to the


Change to a lower-case "i" for "incubation".

I noticed that Hyperledger's own project life cycle document uses a capital I (and italics) for Incubation, even in the middle of a sentence. Although I disagree with their style choice, you could choose to follow their convention for this term. Or you could follow best practices for writing and grammar. I leave this decision up to you.

annechenette · 2019-01-17T22:59:41Z

README.md

- [Documentation](#documentation)
- [License](#license)
+This Hyperledger project is in _Incubation_. It was proposed to the
+community and documented [here](https://docs.google.com/document/d/1b6ES0bKUK30E2iZizy3vjVEhPn7IvsW5buDo7nFXBE0/edit).


Change the link text from "here" to something descriptively specific, such as:

"in this [Hyperledger Grid Proposal](..."

Also, should the link to the doc go straight to edit mode? I recommend deleting /edit from the URL.

I did not strip /edit off the URL. This just causes an additional redirect.

annechenette · 2019-01-17T23:00:38Z

README.md

- [License](#license)
+This Hyperledger project is in _Incubation_. It was proposed to the
+community and documented [here](https://docs.google.com/document/d/1b6ES0bKUK30E2iZizy3vjVEhPn7IvsW5buDo7nFXBE0/edit).
+Information on what _Incubation_ entails can be found in the


s/entails/means/

Also, if you change to "incubation" above, make the same change here.

annechenette · 2019-01-17T23:09:35Z

README.md

 [Apache License Version 2.0](LICENSE) software license.

-Hyperledger Sawtooth Supply Chain documentation in the [docs](docs)
+Hyperledger Grid documentation in the [docs](docs)


This sentence seems malformed at first. To smooth it out, I'd start this sentence with "The".

annechenette · 2019-01-17T23:15:12Z

README.md


-![Hyperledger Sawtooth](images/sawtooth_logo_light_blue-small.png)
+Grid is a WebAssembly-based project for building supply chain solutions. It


Say "Hyperledger Grid" instead of "Grid" here and elsewhere.

I did this, though I'm not sure I agree with it, as it changes the tone.

Signed-off-by: Shawn T. Amundson <amundson@bitwise.io>

Merge splinter into canopyjs repo and remove unnecessary files

Merge splinter into saplingjs repo and remove unnecessary files

vaporos self-assigned this Jan 17, 2019

vaporos requested review from peterschwarz, boydjohnson, dcmiddle, jsmitchell, agunde406, dplumb94, davececchi and annechenette January 17, 2019 22:43

jsmitchell approved these changes Jan 17, 2019

View reviewed changes

peterschwarz approved these changes Jan 17, 2019

View reviewed changes

annechenette suggested changes Jan 17, 2019

View reviewed changes

Update the README.md to reflect Grid (was: Sawtooth Supply Chain)

9832f94

Signed-off-by: Shawn T. Amundson <amundson@bitwise.io>

vaporos force-pushed the update-readme branch from 0cd79d3 to 9832f94 Compare January 18, 2019 06:01

annechenette approved these changes Jan 18, 2019

View reviewed changes

vaporos merged commit 9273e4e into hyperledger-archives:master Jan 18, 2019

ameliabradley pushed a commit to ameliabradley/grid that referenced this pull request Jul 29, 2022

Merge pull request hyperledger-archives#2 from dplumb94/merge-splinter

64f942e

Merge splinter into canopyjs repo and remove unnecessary files

ameliabradley pushed a commit to ameliabradley/grid that referenced this pull request Jul 29, 2022

Merge pull request hyperledger-archives#2 from dplumb94/merge-splinter

ba5e012

Merge splinter into saplingjs repo and remove unnecessary files

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update the README.md to reflect Grid (was: Sawtooth Supply Chain) #2

Update the README.md to reflect Grid (was: Sawtooth Supply Chain) #2

vaporos commented Jan 17, 2019

annechenette Jan 17, 2019

annechenette Jan 17, 2019

vaporos Jan 18, 2019

annechenette Jan 17, 2019

annechenette Jan 17, 2019

vaporos Jan 18, 2019

annechenette Jan 17, 2019

annechenette Jan 17, 2019 •

edited

Loading

vaporos Jan 18, 2019

annechenette Jan 17, 2019

vaporos Jan 18, 2019

vaporos Jan 18, 2019

annechenette Jan 17, 2019

annechenette Jan 17, 2019

vaporos Jan 18, 2019

annechenette Jan 17, 2019

vaporos Jan 18, 2019

annechenette Jan 17, 2019 •

edited

Loading

vaporos Jan 18, 2019


		![Hyperledger Sawtooth](images/sawtooth_logo_light_blue-small.png)
		Grid is a WebAssembly-based project for building supply chain solutions. It

Update the README.md to reflect Grid (was: Sawtooth Supply Chain) #2

Update the README.md to reflect Grid (was: Sawtooth Supply Chain) #2

Conversation

vaporos commented Jan 17, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

annechenette Jan 17, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

annechenette Jan 17, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

annechenette Jan 17, 2019 •

edited

Loading

annechenette Jan 17, 2019 •

edited

Loading