From ea961fcd0744d1f736804cc0b7616213c5e4d015 Mon Sep 17 00:00:00 2001 From: MaysWind Date: Sun, 26 Mar 2017 20:15:00 +0800 Subject: [PATCH] add readme --- README.md | 53 ++++++++++++----------------------------------------- 1 file changed, 12 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index d44ce36..f6dceda 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,26 @@ -# AriaNg -[![License](https://img.shields.io/github/license/mayswind/AriaNg.svg?style=flat)](https://github.com/mayswind/AriaNg/blob/master/LICENSE) -[![Lastest Build](https://img.shields.io/circleci/project/mayswind/AriaNg.svg?style=flat)](https://circleci.com/gh/mayswind/AriaNg/tree/master) -[![Lastest Release](https://img.shields.io/github/release/mayswind/AriaNg.svg?style=flat)](https://github.com/mayswind/AriaNg/releases) +# AriaNg Native +[![License](https://img.shields.io/github/license/mayswind/AriaNg-Native.svg?style=flat)](https://github.com/mayswind/AriaNg-Native/blob/master/LICENSE) +[![Lastest Release](https://img.shields.io/github/release/mayswind/AriaNg-Native.svg?style=flat)](https://github.com/mayswind/AriaNg-Native/releases) ## Introduction -AriaNg is a web frontend making [aria2](https://github.com/aria2/aria2) better. AriaNg is written in pure html & javascript, thus it does not need any compilers or runtime environment. You can just put AriaNg in your web server and open it in your browser. AriaNg uses responsive layout, and supports any desktop or mobile devices. +AriaNg Native is a native app of [AriaNg](https://github.com/mayswind/AriaNg), you can run it on Windows or macOS without any browser. -## Features -1. Pure Html & Javascript, no runtime required -2. Responsive design, supporting desktop and mobile devices -3. User-friendly interface - * Sort tasks (by name, size, progress, remain time, download speed, etc.), files, peers - * Search tasks - * Adjust download order by dragging task - * More information of tasks (health percentage, client infomation of bt peers, etc.) - * Filter files of tasks in file types (by videos, audios, pictures, documents, applications, archives, etc.) - * Download/upload history chart of global or task - * Full support of aria2 settings -4. Url command line api support -5. Download finished notification -6. Multi-languages support -7. Multi aria2 RPC host support -8. Less bandwidth usage, only requesting incremental data - -## Screenshots -#### Desktop -![AriaNg](https://raw.githubusercontent.com/mayswind/AriaNg-WebSite/master/screenshots/desktop.png) -#### Mobile Device -![AriaNg](https://raw.githubusercontent.com/mayswind/AriaNg-WebSite/master/screenshots/mobile.png) +## Introduction of AriaNg +Please visit [https://github.com/mayswind/AriaNg](https://github.com/mayswind/AriaNg) for more information. ## Installation #### Prebuilt release -Latest Release: [https://github.com/mayswind/AriaNg/releases](https://github.com/mayswind/AriaNg/releases) - -Latest Daily Build: [https://github.com/mayswind/AriaNg-DailyBuild/archive/master.zip](https://github.com/mayswind/AriaNg-DailyBuild/archive/master.zip) +Latest Release: [https://github.com/mayswind/AriaNg-Native/releases](https://github.com/mayswind/AriaNg-Native/releases) #### Building from source -Make sure you have [Node.js](https://nodejs.org/), [NPM](https://www.npmjs.com/) and [Bower](https://bower.io/) installed. Then download the source code, and follow these steps. +Make sure you have [Node.js](https://nodejs.org/) and [NPM](https://www.npmjs.com/) installed. Then download the source code, and follow these steps. $ npm install - $ bower install - $ gulp clean build + + # For Windows + $ npm run publish:win The builds will be placed in the dist directory. -## Documents -1. [English](http://ariang.mayswind.net) -2. [Simplified Chinese (简体中文)](http://ariang.mayswind.net/zh_Hans) - -## Demo -Please visit [http://ariang.mayswind.net/latest](http://ariang.mayswind.net/latest) - ## License -[MIT](https://github.com/mayswind/AriaNg/blob/master/LICENSE) +[MIT](https://github.com/mayswind/AriaNg-Native/blob/master/LICENSE)