status-im/liquid-funding
2
0
Fork 0
mirror of https://github.com/status-im/liquid-funding.git synced 2025-01-11 03:56:20 +00:00
Code Issues Projects Releases Wiki Activity

initial readme

Browse Source
This commit is contained in:
Barry Gitarts 2019-01-07 15:39:44 -05:00
parent d4f63a6b51
commit 5efc0fd300
1 changed files with 12 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -1,44 +1,25 @@
![Liquid Pledging](readme-header.png)
- - -
> Ethereum contract to delegate donations to projects.
<p align="center">
<a href="https://gitter.im/status-im/liquid-funding"><img src="https://badges.gitter.im/Join Chat.svg" alt="Gitter"></a>
</p>
[![Build Status](https://travis-ci.org/Giveth/liquidpledging.svg?branch=master)](https://travis-ci.org/Giveth/liquidpledging)
- - -
Welcome to the code for the liquidpledging contract, a new way to distribute donated ether while keeping ownership in the hands of the original donor.
Welcome to the code for the liquid-funding dapp which uses the liquidpledging contracts by Giveth, a new way to distribute donated ether while keeping ownership in the hands of the original donor.
## Table of content
- [Getting Started](#getting-started)
- [Install](#install)
- [Requirements](#requirements)
- [Package](#package)
- [Run demo](#run-demo)
- [Help](#help)
### Install
1. Click **Star** on this repo near the top-right corner of this web page (if you want to).
2. Join our [Riot](http://join.giveth.io) if you haven't already.
3. Fork this repo by clicking **Fork** button in top-right corner of this web page. Continue to follow instruction steps from your own liquidpledging repo.
5. The rest of these steps must be done from your machine's command line. Clone your own "liquidpledging" repo:
```
git clone https://github.com/GITHUB_USERNAME/liquidpledging.git
```
6. Change directories to liquidpledging:
```
cd liquidpledging
```
1) `npm install`
2) `npm -g install embark@4.0.0-alpha.2`
3) For development `embark run` or `embark run {network}`
### Requirements
Make sure you have [NodeJS](https://nodejs.org/) (v8.4.0 or higher) and [npm](https://www.npmjs.com/) (5.4.1 or higher) installed.
### Package
The liquidpledging contract is published as an npm package for developer convenience. To include it as a dependency in your package.json run this from your apps root dirctory.
```
npm install liquidpledging --save
```
## Run demo
Follow the instructions on the [liquidpleding-demo](https://github.com/ojones/liquidpledging-demo) repo.
## Help
Reach out to us on [slack](http://slack.giveth.io) for any help or to share ideas.
[NodeJS](https://nodejs.org/) (v8.4.0 or higher)
[npm](https://www.npmjs.com/) (5.4.1 or higher)
[Embark](https://embark.status.im/) (v4.0.0-alpha 2)