From 74adde4847d443ba14011aadfe47b5e546f8bc38 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Miguel=20Moreno?= Date: Sun, 13 Jan 2019 14:32:08 +0100 Subject: [PATCH] Created README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2d9223c --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# IOTA Web Wallet +[![Open Web App](https://img.shields.io/badge/open-webapp-04a997.svg)](https://iotawebwallet.com/) +[![Travis CI](https://travis-ci.com/josemmo/iotawebwallet.svg?branch=master)](https://travis-ci.com/josemmo/iotawebwallet) +[![License](https://img.shields.io/github/license/josemmo/iotawebwallet.svg)](COPYING) + +[IOTA Web Wallet](https://iotawebwallet.com/) is an Open Source and Free Software project that aims to provide a reliable and complete app for managing IOTA wallets directly from the web. + +It uses the official [iota.js](https://github.com/iotaledger/iota.js) library to perform all Tangle-related operations. It also encrypts your seeds and stores them in your browser local storage instead of sending them to a third-party server. + +## Building the app +If you prefer to build the app yourself instead of using the latest version online, you'll need NodeJS with NPM/Yarn: +```bash +# Clone this repository +git clone https://github.com/josemmo/iotawebwallet +cd iotawebwallet + +# Install dependencies +npm install + +# Build the app +npm run build +``` + +## License +IOTA Web Wallet is provided under the [GNU General Public License](COPYING) and uses libraries under MIT and WTFPL licenses.