This repository has been archived by the owner on Nov 2, 2018. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #805 from NebulousLabs/gitlab-readme
Update Readme
- Loading branch information
Showing
1 changed file
with
1 addition
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,49 +1,3 @@ | ||
# [![Sia Logo](http://sia.tech/img/svg/sia-green-logo.svg)](http://sia.tech/) User Interface | ||
|
||
[![Build Status](https://travis-ci.org/NebulousLabs/Sia-UI.svg?branch=master)](https://travis-ci.org/NebulousLabs/Sia-UI) | ||
[![devDependency Status](https://david-dm.org/NebulousLabs/Sia-UI/dev-status.svg)](https://david-dm.org/NebulousLabs/Sia-UI#info=devDependencies) | ||
[![dependencies Status](https://david-dm.org/NebulousLabs/Sia-UI.svg)](https://david-dm.org/NebulousLabs/Sia-UI#info=dependencies) | ||
[![Known Vulnerabilities](https://snyk.io/test/github/NebulousLabs/Sia-UI/badge.svg)](https://snyk.io/test/github/NebulousLabs/Sia-UI) | ||
[![license:mit](https://img.shields.io/badge/license-mit-blue.svg)](https://opensource.org/licenses/MIT) | ||
|
||
# A Highly Efficient Decentralized Storage Network | ||
|
||
![A snapshot of the file library](/doc/assets/files.png) | ||
This is the user interface for [Sia](https://github.com/NebulousLabs/Sia), it | ||
is a desktop application based off the | ||
[electron](https://github.com/atom/electron) framework. The ambition behind | ||
this project is to facilitate easy, graphical interaction between users and | ||
the Sia network. | ||
|
||
## Prerequisites | ||
|
||
- [siad](https://github.com/NebulousLabs/Sia) | ||
- [node & npm 6.9.0 LTS](https://nodejs.org/download/) | ||
Earlier node versions may work, but they do not have guaranteed support. | ||
- `libxss` is a required dependency for Electron on Debian, it can be installed with `sudo apt-get install libxss1`. | ||
|
||
## Running | ||
|
||
[Download your OS's release archive and unzip it](https://github.com/NebulousLabs/Sia-UI/releases) | ||
|
||
### OR | ||
|
||
Run from source | ||
|
||
0. Install dependencies mentioned above | ||
1. Download or `git clone` the repository | ||
2. npm install | ||
3. npm start | ||
|
||
## [Contributing](doc/Developers.md) | ||
|
||
Read the document linked above to learn more about the application and its technologies. | ||
|
||
Take a look at our [issues page](https://github.com/NebulousLabs/Sia-UI/issues) | ||
for a high level view of what objectives we're working on. | ||
|
||
If you're the type to jump right into code, simply search through the project | ||
(sans the `node_modules` folder) for the term `TODO:`. If you're on a UNIX | ||
(Linux & OSX) system, run `grep -r 'TODO:' js plugins` in a terminal at the | ||
root level of the project | ||
|
||
This project has moved to Gitlab: https://gitlab.com/NebulousLabs/Sia-UI |