Skip to content

Commit

Permalink
README: update for standard readme compliance, including adding a LIC…
Browse files Browse the repository at this point in the history
…ENSE, plus a Gitter badge, etc. (#156)

* Add a short description, standard readme style

* Add a Gitter badge

* Update for standard readme compliance

* Add a Casper Gitter badge, update the existing one to Casper Scaling and protocol economics

* Create LICENSE

* Fix Gitter casper scaling and protocol economics badge, update Gitter link

* Remove repeated contribute section

* Add a made by badge

* Remove :
  • Loading branch information
jamesray1 authored and ChihChengLiang committed May 31, 2018
1 parent 02b06b1 commit d4f93ad
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 12 deletions.
24 changes: 24 additions & 0 deletions LICENSE
@@ -0,0 +1,24 @@
This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org>
34 changes: 22 additions & 12 deletions README.md
@@ -1,18 +1,19 @@
# Casper

[![](https://img.shields.io/badge/made%20by-Ethereum%20Foundation-blue.svg?style=flat-square)](http://ethereum.org)
[![Build Status](https://travis-ci.org/ethereum/casper.svg?branch=master)](https://travis-ci.org/ethereum/casper)
[![Casper](https://img.shields.io/badge/gitter-Casper-4AB495.svg)](https://gitter.im/ethereum/casper)
[![Casper scaling and protocol economics](https://img.shields.io/badge/gitter-Casper%20scaling%20and%20protocol%20economics-4AB495.svg)](https://gitter.im/ethereum/casper-scaling-and-protocol-economics)
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

## Resources
> Implements Casper FFG (the Friendly Finality Gadget), a Proof-of-Stake finality protocol on top of Proof-of-Work.
## Background

- Implements a [Casper FFG](https://arxiv.org/abs/1710.09437) smart contract, written in [Vyper](https://github.com/ethereum/vyper).
- See this [Casper the Friendly Finality Gadget](https://arxiv.org/abs/1710.09437) paper by Vitalik Buterin and Virgil Griffith introducing Casper FFG.
- [EIP-1011](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1011.md):
specification of the Casper the Friendly Finality Gadget (FFG) PoW/PoS consensus model.
- [VALIDATOR_GUIDE.md](https://github.com/ethereum/casper/blob/master/VALIDATOR_GUIDE.md):
information about implementing a Casper FFG validator.
- [Casper the Friendly Finality Gadget](https://arxiv.org/abs/1710.09437):
paper by Vitalik Buterin and Virgil Griffith introducing Casper FFG.

## Casper Contract
Implements [Casper FFG](https://arxiv.org/abs/1710.09437), written in [Vyper](https://github.com/ethereum/vyper).

## Installation

Expand All @@ -31,12 +32,21 @@ pip3 install -r requirements.txt
NOTE: pip3 is a version of pip using python version 3.
NOTE: we suggest using virtualenv to sandbox your setup.

## Usage

- [VALIDATOR_GUIDE.md](https://github.com/ethereum/casper/blob/master/VALIDATOR_GUIDE.md):
information about implementing a Casper FFG validator.

## Contribute

Feel free to ask questions in our [Gitter room](https://gitter.im/ethereum/casper) or open an [issue](https://github.com/ethereum/casper/issues) for feature requests or bug reports. Feel free to make a PR!

## License

[UNLICENSE](LICENSE)

## Tests

```bash
pytest tests
```

## Contribute

Join the conversation here: [https://gitter.im/ethereum/casper](https://gitter.im/ethereum/casper)

0 comments on commit d4f93ad

Please sign in to comment.