Update README.md

This commit is contained in:
alexm-status 2018-05-27 22:03:25 -07:00 committed by GitHub
parent 93296d40c1
commit 57a85c8f60
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 11 deletions

View File

@ -1,20 +1,22 @@
# Nim-eth-rpc
**Nim-eth-rpc**
[![Build Status (Travis)](https://img.shields.io/travis/status-im/nim-eth-rpc/master.svg?label=Linux%20/%20macOS "Linux/macOS build status (Travis)")](https://travis-ci.org/status-im/nim-eth-rpc)
[![Windows build status (Appveyor)](https://img.shields.io/appveyor/ci/jarradh/nim-eth-rpc/master.svg?label=Windows "Windows build status (Appveyor)")](https://ci.appveyor.com/project/jarradh/nim-eth-rpc)
Nim-eth-rpc is designed to provide remote procedure calls to the Nimbus Ethereum research project.
## Installation
### Requirements
* Nim 17.3 and up
# Installation
`git clone https://github.com/status-im/nim-eth-rpc`
## Usage
### Server
## Requirements
* Nim 17.3 and up
# Usage
## Server
```nim
import rpcserver, asyncdispatch
@ -25,7 +27,7 @@ when isMainModule:
runForever()
```
### Client
## Client
```nim
import rpcclient, asyncdispatch, json
@ -40,10 +42,10 @@ waitFor main()
```
## Contributing
# Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)
# License
[MIT](https://choosealicense.com/licenses/mit/)