diff --git a/README.md b/README.md index 5ffc18e..0ff5f9d 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,16 @@ -![Build Status](https://travis-ci.org/xpepermint/rawmodeljs.svg?branch=master)  -[![Dependency Status](https://gemnasium.com/badges/github.com/0xcert/ethereum.svg)](https://gemnasium.com/github.com/0xcert/ethereum) + -# [0xcert](https://0xcert.org)-[ethereum](https://ethereum.org) +![Build Status](https://travis-ci.org/0xcert/ethereum.svg?branch=master)  +[![Dependency Status](https://gemnasium.com/badges/github.com/0xcert/ethereum.svg)](https://gemnasium.com/github.com/0xcert/ethereum) > 0xcert protocol implementation for Ethereum blockchain. -This is the official implementation of the 0xcert protocol for the Ethereum blockchain. It follows the technical details described in the official [0xcert whitepaper](/0xcert/whitepaper). This is an open source repository and the project is build with [Truffle framework](http://truffleframework.com). - -## Development - -* Run `npm install` to install dependencies. - -* Run `npm test` to run tests. +This is the official implementation of the 0xcert protocol for the Ethereum blockchain. It follows the technical details described in the official [0xcert whitepaper](/0xcert/whitepaper). -* Run `npm run flatten` to merge the source code into a single file. - -## Credits - -* Kristijan Sedlak, *author* -* Luka Kacil, *author* -* Tadej Vengust, *author* +This is an open source repository and the project is build with [Truffle framework](http://truffleframework.com). ## License (MIT) ``` Copyright (c) 2018 0xcert . - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated modelation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. ``` \ No newline at end of file diff --git a/assets/cover.png b/assets/cover.png new file mode 100644 index 0000000..b6b332c Binary files /dev/null and b/assets/cover.png differ diff --git a/package.json b/package.json index f9fb412..8c9b7a7 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,7 @@ { - "name": "0xcert-ethereum", + "name": "@0xcert/ethereum", "version": "0.1.0", "description": "0xcert protocol implementation for Ethereum blockchain.", - "private": true, "main": "truffle.js", "directories": { "contracts": "contracts", @@ -18,14 +17,39 @@ "setup:ganache": "ganache-cli", "setup:env": "npm-run-all -p setup:ganache setup:migrate" }, - "author": "https://0xcert.org", + "author": "0xcert", "license": "MIT", + "repository": { + "type": "git", + "url": "git+https://github.com/0xcert/ethereum.git" + }, + "bugs": { + "url": "https://github.com/0xcert/ethereum/issues" + }, + "homepage": "https://github.com/0xcert/ethereum#readme", + "keywords": [ + "0xcert", + "protocol", + "ethereum", + "eth", + "contracts", + "contract", + "smart", + "smart-contracts", + "smart-contract", + "tokens", + "token", + "xct", + "xcert", + "non-fungible", + "erc721" + ], "devDependencies": { - "ethjs-util": "0.1.4", + "ethjs-util": "^0.1.4", "ganache-cli": "^6.1.0", "npm-run-all": "^4.1.2", "truffle": "^4.1.0", - "truffle-flattener": "1.2.0", + "truffle-flattener": "^1.2.0", "web3-utils": "^1.0.0-beta.30" } }