Cleaned up READMEs and removed spam-limited badges

joincivil · Apr 12, 2018 · 06846d4 · 06846d4
1 parent c0c63bb
commit 06846d4
Show file tree

Hide file tree

Showing 9 changed files with 41 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -12,21 +12,21 @@ We hope that those tools will be useful for creation of interesting applications
 
 ### Published packages
 
-| Package                                             | Badges                                                                                                                                                                                                                                       | Description                                                 |
-| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
-| [`@joincivil/core`][core-url]                       | [![npm (scoped)](https://img.shields.io/npm/v/@joincivil/core.svg)](https://www.npmjs.com/package/@joincivil/core)[![license](https://img.shields.io/badge/license-LGPL%20v2.1-green.svg)](/packages/core/LICENSE)                           | JS library for interacting with Civil ecosystem             |
-| [`@joincivil/tslint-rules`](/packages/tslint-rules) | [![npm (scoped)](https://img.shields.io/npm/v/@joincivil/tslint-rules.svg)](https://www.npmjs.com/package/@joincivil/tslint-rules)[![license](https://img.shields.io/badge/license-Apache%20v2.0-green.svg)](/packages/tslint-rules/LICENSE) | Linting rules for Civil's Typescript packages               |
-| [`@joincivil/utils`](/packages/utils)               | [![npm (scoped)](https://img.shields.io/npm/v/@joincivil/utils.svg)](https://www.npmjs.com/package/@joincivil/utils)[![license](https://img.shields.io/badge/license-Apache%20v2.0-green.svg)](/packages/utils/LICENSE)                      | Utilities shared between Civil projects used during runtime |
+| Package                                             | NPM                                                                                                                           | Description                                                 |
+| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
+| [`@joincivil/core`][core-url]                       | [![npm link](https://img.shields.io/badge/npm-core-blue.svg)](https://www.npmjs.com/package/@joincivil/core)                  | JS library for interacting with Civil ecosystem             |
+| [`@joincivil/tslint-rules`](/packages/tslint-rules) | [![npm link](https://img.shields.io/badge/npm-tslint--rules-blue.svg)](https://www.npmjs.com/package/@joincivil/tslint-rules) | Linting rules for Civil's Typescript packages               |
+| [`@joincivil/utils`](/packages/utils)               | [![npm link](https://img.shields.io/badge/npm-utils-blue.svg)](https://www.npmjs.com/package/@joincivil/utils)                | Utilities shared between Civil projects used during runtime |
+| [`@joincivil/editor`](/packages/editor)             | [![npm link](https://img.shields.io/badge/npm-editor-blue.svg)](https://www.npmjs.com/package/@joincivil/editor)              | Editor for Civil-formatted articles and content             |
 
 ### Private packages
 
-| Package                                       | License                                                                                                 | Description                                                                                                         |
-| --------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
-| [`@joincivil/contracts`](/packages/contracts) | [![license](https://img.shields.io/badge/license-LGPL%20v2.1-green.svg)](/packages/contracts/LICENSE)   | Smart-contracts needed for the Civil's protocol                                                                     |
-| [`@joincivil/dapp`](/packages/dapp)           | [![license](https://img.shields.io/badge/license-Apache%20v2.0-green.svg)](/packages/dapp/LICENSE)      | DApp for interacting with the Civil contracts                                                                       |
-| [`@joincivil/dev-utils`](/packages/dev-utils) | [![license](https://img.shields.io/badge/license-Apache%20v2.0-green.svg)](/packages/dev-utils/LICENSE) | Utilities needed for the proper working of the mono-repo packages, builds and tests                                 |
-| [`@joincivil/debug-ui`](/packages/debug-ui)   | [![license](https://img.shields.io/badge/license-Apache%20v2.0-green.svg)](/packages/debug-ui/LICENSE)  | WIP: Minimal website to monitor, observe and debug the protocol and all the utilities and packages of the ecosystem |
-| [`@joincivil/editor`](/packages/editor)       | [![license](https://img.shields.io/badge/license-Apache%20v2.0-green.svg)](/packages/editor/LICENSE)    | WIP: Editor for Civil-formatted articles and content                                                                |
+| Package                                       | Description                                                                                                         |
+| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
+| [`@joincivil/contracts`](/packages/contracts) | Smart-contracts needed for the Civil's protocol                                                                     |
+| [`@joincivil/dapp`](/packages/dapp)           | DApp for interacting with the Civil contracts                                                                       |
+| [`@joincivil/dev-utils`](/packages/dev-utils) | Utilities needed for the proper working of the mono-repo packages, builds and tests                                 |
+| [`@joincivil/debug-ui`](/packages/debug-ui)   | WIP: Minimal website to monitor, observe and debug the protocol and all the utilities and packages of the ecosystem |
 
 ## Usage
 

diff --git a/packages/contracts/README.md b/packages/contracts/README.md
@@ -49,12 +49,8 @@ Inside this package there are multiple smart-contracts from multiple open-source
 While we're working to get everything under LGPLv2.1 this is not currently possible.
 [`contracts`](./contracts) and [`test`](./test) folders are split into subfolders with specific names, code under those subfolders is licensed under licenses as follow:
 
-| Subfolder       | License                                                                                              | Original source                                                   |
-| --------------- | ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
-| `tcr/`          | [![license](https://img.shields.io/badge/license-Apache%20v2.0-green.svg)](./licenses/LICENSE-tcr)   | [skmgoldin/tcr](https://github.com/skmgoldin/tcr)                 |
-| `multisig/`     | [![license](https://img.shields.io/badge/license-LGPL%20v2.1-green.svg)](./licenses/LICENSE-general) | [gnosis/MultiSigWallet](https://github.com/gnosis/MultiSigWallet) |
-| `anything else` | [![license](https://img.shields.io/badge/license-LGPL%20v2.1-green.svg)](./licenses/LICENSE-general) | [civil/Civil](https://github.com/joincivil/Civil)                 |
-
-### Multisig
-
-Diverged from Gnosis at [ac93a926aac155fb50590130edaa0b26b3487ba4](https://github.com/gnosis/MultiSigWallet/commit/ac93a926aac155fb50590130edaa0b26b3487ba4) commit.
+| Subfolder       | License                                                                                              | Original source                                                                                                   |
+| --------------- | ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
+| `tcr/`          | [![license](https://img.shields.io/badge/license-Apache%20v2.0-green.svg)](./licenses/LICENSE-tcr)   | [skmgoldin/tcr](https://github.com/skmgoldin/tcr)                                                                 |
+| `multisig/`     | [![license](https://img.shields.io/badge/license-LGPL%20v2.1-green.svg)](./licenses/LICENSE-general) | [gnosis/MultiSigWallet](https://github.com/gnosis/MultiSigWallet/commit/ac93a926aac155fb50590130edaa0b26b3487ba4) |
+| `anything else` | [![license](https://img.shields.io/badge/license-LGPL%20v2.1-green.svg)](./licenses/LICENSE-general) | [civil/Civil](https://github.com/joincivil/Civil)                                                                 |
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -2,6 +2,8 @@
 
 This library is the main-entry point for any developer wanting to work with the Civil ecosystem. It abstracts communication with the Ethereum blockchain as well as storing and loading articles from file storage servers.
 
+[![license](https://img.shields.io/badge/license-LGPL%20v2.1-green.svg)](./LICENSE)
+
 ## Installation
 
 ```bash

diff --git a/packages/dapp/README.md b/packages/dapp/README.md
@@ -1,9 +1,9 @@
-This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).
-
 # Civil DApp
 
 This package contains a React + Typescript app that functions as a DApp for the Civil platform. It is intended to have a nice UX for users to interact with the TCR and Newsrooms.
 
+[![license](https://img.shields.io/badge/license-Apache%20v2.0-green.svg)](./LICENSE)
+
 ## To Build for Production
 
 Run `yarn build`

diff --git a/packages/debug-ui/README.md b/packages/debug-ui/README.md
@@ -1,7 +1,8 @@
-# Static Pug + Typescript + Sass starter
+# @joincivil/debug-ui
 
-This starter allows easy creation of static webpages while allowing nicieties of npm
-packagaes, Typescript, Sass and Pug
+Minimal amount of code to be able to debug stuff inside Civil smart-contracts
+
+[![license](https://img.shields.io/badge/license-Apache%20v2.0-green.svg)](./LICENSE)
 
 ## Start serve server
 

diff --git a/packages/dev-utils/README.md b/packages/dev-utils/README.md
@@ -1,3 +1,5 @@
-# dev-utils
+# @joincivil/dev-utils
 
-Utilities shared between multiple JoinCivil packages
+Utilities shared between multiple JoinCivil packages used in development.
+
+[![license](https://img.shields.io/badge/license-Apache%20v2.0-green.svg)](./LICENSE)
diff --git a/packages/editor/README.md b/packages/editor/README.md
@@ -0,0 +1,5 @@
+# @joincivil/editor
+
+Editor for Civil-formatted articles and content
+
+[![license](https://img.shields.io/badge/license-Apache%20v2.0-green.svg)](./LICENSE)
diff --git a/packages/tslint-rules/README.md b/packages/tslint-rules/README.md
@@ -2,6 +2,8 @@
 
 Shared rules for Typescript linter
 
+[![license](https://img.shields.io/badge/license-Apache%20v2.0-green.svg)](./LICENSE)
+
 ## Installation
 
 Your tslint needs to be `>=5.9` for the yaml support

diff --git a/packages/utils/README.md b/packages/utils/README.md
@@ -0,0 +1,5 @@
+# @joincivi/utils
+
+Utilities shared between multiple JoinCivil packages
+
+[![license](https://img.shields.io/badge/license-Apache%20v2.0-green.svg)](./LICENSE)
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,6 +2,8 @@ @@
     This library is the main-entry point for any developer wanting to work with the Civil ecosystem. It abstracts communication with the Ethereum blockchain as well as storing and loading articles from file storage servers.
+    [![license](https://img.shields.io/badge/license-LGPL%20v2.1-green.svg)](./LICENSE)
     ## Installation
     ```bash
@@ Expand Down @@