From 999cf1be7cc7bef3c10fc68e097e70e5cd795ed6 Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Mon, 19 Jun 2017 08:57:27 -0700 Subject: Improve the README --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index fd0fdb86f..50d6b442b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,19 @@ -# 0x.js + + +--- + +[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 -- cgit