Skip to content

Commit

Permalink
fix casing of “Chainlink”
Browse files Browse the repository at this point in the history
  • Loading branch information
se3000 authored and dimroc committed Mar 16, 2018
1 parent f1f3081 commit 7033254
Showing 1 changed file with 17 additions and 11 deletions.
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@

ChainLink is middleware to simplify communication with blockchains. Here you'll find the ChainLink Golang node, currently in alpha. This initial implementation is intended for use and review by developers, and will go on to form the basis for ChainLink's [decentralized oracle network](https://link.smartcontract.com/whitepaper). Further development of the ChainLink Node and ChainLink Network will happen here, if you are interested in contributing please see our [contribution guidelines](https://github.com/smartcontractkit/chainlink/blob/master/CONTRIBUTING.md). The current node supports:
# Chainlink [![Travis-CI](https://travis-ci.org/smartcontractkit/chainlink.svg?branch=master)](https://travis-ci.org/smartcontractkit/chainlink) [![Maintainability](https://api.codeclimate.com/v1/badges/273722bb9f6f22d799bd/maintainability)](https://codeclimate.com/github/smartcontractkit/chainlink/maintainability) [![Go Report Card](https://goreportcard.com/badge/github.com/smartcontractkit/chainlink)](https://goreportcard.com/report/github.com/smartcontractkit/chainlink) [![Join the chat at https://gitter.im/smartcontractkit-chainlink/Lobby](https://badges.gitter.im/smartcontractkit-chainlink/Lobby.svg)](https://gitter.im/smartcontractkit-chainlink/Lobby) [![codecov](https://codecov.io/gh/smartcontractkit/chainlink/branch/master/graph/badge.svg)](https://codecov.io/gh/smartcontractkit/chainlink) [![GoDoc](https://godoc.org/github.com/smartcontractkit/chainlink?status.svg)](https://godoc.org/github.com/smartcontractkit/chainlink)

Chainlink is middleware to simplify communication with blockchains.
Here you'll find the Chainlink Golang node, currently in alpha.
This initial implementation is intended for use and review by developers,
and will go on to form the basis for Chainlink's [decentralized oracle network](https://link.smartcontract.com/whitepaper).
Further development of the Chainlink Node and Chainlink Network will happen here,
if you are interested in contributing please see our [contribution guidelines](https://github.com/smartcontractkit/chainlink/blob/master/CONTRIBUTING.md).
The current node supports:
- easy connectivity of on-chain contracts to any off-chain computation or API
- multiple methods for scheduling both on-chain and off-chain computation for a user's smart contract
- automatic gas price bumping to prevent stuck transactions, assuring your data is delivered in a timely manner
Expand All @@ -15,13 +21,13 @@ Examples of how to utilize and integrate Chainlinks can be found in our [Hello C

1. [Install Go 1.9+](https://golang.org/doc/install#install), and add your GOPATH's [bin directory to your PATH](https://golang.org/doc/code.html#GOPATH)
2. Install [dep](https://github.com/golang/dep#installation): `$ brew install dep` <br> or `$ go get -u github.com/golang/dep/cmd/dep`
3. Download ChainLink: `$ go get -d github.com/smartcontractkit/chainlink && cd $GOPATH/src/github.com/smartcontractkit/chainlink`
3. Download Chainlink: `$ go get -d github.com/smartcontractkit/chainlink && cd $GOPATH/src/github.com/smartcontractkit/chainlink`
4. Install: `$ make install`
5. Run the node: `$ chainlink help`

### Ethereum Node Requirements

In order to run the ChainLink node you must have access to a running Ethereum node with an open websocket connection.
In order to run the Chainlink node you must have access to a running Ethereum node with an open websocket connection.
Any Ethereum based network will work once you've [configured](https://github.com/smartcontractkit/chainlink#configure) the chain ID.
Ethereum node versions currently tested and supported:

Expand All @@ -30,7 +36,7 @@ Ethereum node versions currently tested and supported:

## Run

To start your ChainLink node, simply run:
To start your Chainlink node, simply run:
```bash
$ chainlink node
```
Expand All @@ -45,7 +51,7 @@ View details of a specific job with:
$ chainlink show $JOB_ID
```

To find out more about the ChainLink CLI, you can always run `chainlink help`.
To find out more about the Chainlink CLI, you can always run `chainlink help`.

Check out the [wiki](https://github.com/smartcontractkit/chainlink/wiki)'s pages on [Adapters](https://github.com/smartcontractkit/chainlink/wiki/Adapters) and [Initiators](https://github.com/smartcontractkit/chainlink/wiki/Initiators) to learn more about how to create Jobs and Runs.
Expand All @@ -65,16 +71,16 @@ You can configure your node's behavior by setting environment variables which ca
ETH_GAS_BUMP_WEI Default: 5000000000 (5 gwei)
ETH_GAS_PRICE_DEFAULT Default: 20000000000 (20 gwei)

When running the CLI to talk to a ChainLink node on another machine, you can change the following environment variables:
When running the CLI to talk to a Chainlink node on another machine, you can change the following environment variables:

CLIENT_NODE_URL Default: http://localhost:6688
USERNAME Default: chainlink
PASSWORD Default: twochains

## External Adapters

External adapters are what make ChainLink easily extensible, providing simple integration of custom computations and specialized APIs.
A ChainLink node communicates with external adapters via a simple REST API.
External adapters are what make Chainlink easily extensible, providing simple integration of custom computations and specialized APIs.
A Chainlink node communicates with external adapters via a simple REST API.

For more information on creating and using external adapters, please see our [external adapters page](https://github.com/smartcontractkit/chainlink/wiki/External-Adapters).

Expand Down Expand Up @@ -143,11 +149,11 @@ $ truffle test
```
### Development Tips

For more tips on how to build and test ChainLink, see our [development tips page](https://github.com/smartcontractkit/chainlink/wiki/Development-Tips).
For more tips on how to build and test Chainlink, see our [development tips page](https://github.com/smartcontractkit/chainlink/wiki/Development-Tips).

## Contributing

ChainLink's source code is [licensed under the MIT License](https://github.com/smartcontractkit/chainlink/blob/master/LICENSE), and contributions are welcome.
Chainlink's source code is [licensed under the MIT License](https://github.com/smartcontractkit/chainlink/blob/master/LICENSE), and contributions are welcome.
Please check out our [contributing guidelines](https://github.com/smartcontractkit/chainlink/blob/master/CONTRIBUTING.md) for more details.
Expand Down

0 comments on commit 7033254

Please sign in to comment.