aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2017-06-19 23:57:27 +0800
committerFabio Berger <me@fabioberger.com>2017-06-19 23:57:27 +0800
commit999cf1be7cc7bef3c10fc68e097e70e5cd795ed6 (patch)
tree7f59da17d7d00a793d07071a08edf488b2ce47bf
parente8574a3948dffe919148bb14665be3c02cc9dbdf (diff)
downloaddexon-sol-tools-999cf1be7cc7bef3c10fc68e097e70e5cd795ed6.tar
dexon-sol-tools-999cf1be7cc7bef3c10fc68e097e70e5cd795ed6.tar.gz
dexon-sol-tools-999cf1be7cc7bef3c10fc68e097e70e5cd795ed6.tar.bz2
dexon-sol-tools-999cf1be7cc7bef3c10fc68e097e70e5cd795ed6.tar.lz
dexon-sol-tools-999cf1be7cc7bef3c10fc68e097e70e5cd795ed6.tar.xz
dexon-sol-tools-999cf1be7cc7bef3c10fc68e097e70e5cd795ed6.tar.zst
dexon-sol-tools-999cf1be7cc7bef3c10fc68e097e70e5cd795ed6.zip
Improve the README
-rw-r--r--README.md19
1 files changed, 17 insertions, 2 deletions
diff --git a/README.md b/README.md
index fd0fdb86f..50d6b442b 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,19 @@
-# 0x.js
+<img src="https://github.com/0xProject/branding/blob/master/0x_Black_CMYK.png" width="200px" >
+
+---
+
+[0x][website-url] is an open protocol that facilitates trustless, low friction exchange of Ethereum-based assets. A full description of the protocol may be found in our [whitepaper][whitepaper-url].
+
+This repository contains a Javascript library that makes it easy to build Relayers and other 0x enabled DApps ontop of the 0x protocol.
[![CircleCI](https://circleci.com/gh/0xProject/0x.js.svg?style=svg&circle-token=61bf7cd8c9b4e11b132089dfcffdd1be277d1e0c)](https://circleci.com/gh/0xProject/0x.js)
-[![Coverage Status](https://coveralls.io/repos/github/0xProject/0x.js/badge.svg?branch=master&t=fp0cXD)](https://coveralls.io/github/0xProject/0x.js?branch=master) \ No newline at end of file
+[![Coverage Status](https://coveralls.io/repos/github/0xProject/0x.js/badge.svg?branch=master&t=fp0cXD)](https://coveralls.io/github/0xProject/0x.js?branch=master)
+[![Slack Status](http://slack.0xProject.com/badge.svg)](http://slack.0xProject.com)
+[![Join the chat at https://gitter.im/0xProject/contracts](https://badges.gitter.im/0xProject/contracts.svg)](https://gitter.im/0xProject/contracts?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+# [Read the docs][docs-url]
+
+[website-url]: https://0xproject.com/
+[whitepaper-url]: https://0xproject.com/pdfs/0x_white_paper.pdf
+[docs-url]: https://0xproject.com/docs/0xjs