change readme and add license file

Author: eclipseglory

CHANGELOG.md

@@ -1,3 +1,3 @@
-## 1.0.0
+## 0.0.1
 
 - Initial version

LICENSE

@@ -0,0 +1,57 @@
+BSD 3-Clause License
+
+Copyright (c) 2020, 老脸叔叔 (eclipsecycling@gmail.com)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.BSD 3-Clause License
+
+Copyright (c) 2020, 老脸叔叔 (eclipsecycling@gmail.com)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1 +1,56 @@
-under developing
+## About
+Dart library for implementing BitTorrent client.
+
+## Support:
+- [BEP 0003 The BitTorrent Protocol Specification](http://www.bittorrent.org/beps/bep_0003.html)
+- [BEP 0006 Fast Extension](http://www.bittorrent.org/beps/bep_0006.html)
+- [BEP 0015 UDP Tracker Protocal](http://www.bittorrent.org/beps/bep_0015.html)
+
+
+Developing:
+
+- [BEP 0005 DHT Protocal](http://www.bittorrent.org/beps/bep_0005.html)
+- [BEP 0011	Peer Exchange (PEX)](http://www.bittorrent.org/beps/bep_0011.html)
+
+- [BEP 0009	Extension for Peers to Send Metadata Files](http://www.bittorrent.org/beps/bep_0009.html)
+- [BEP 0010	Extension Protocol](http://www.bittorrent.org/beps/bep_0010.html)
+
+Other support will come soon.
+
+## How to use
+
+Add package dependencies: `torrent_model` and `torrent_task`:
+```
+dependencies:
+  torrent_model : ^1.0.1
+  torrent_task : ^0.0.1
+```
+
+First , create a `Torrent` model via .torrent file:
+
+```dart
+  var model = await Torrent.parse('some.torrent');
+```
+
+Second, create a `Torrent Task` and start it:
+```dart
+  var task = TorrentTask.newTask(model,'savepath');
+  task.start();
+```
+
+User can add some listener to monitor `TorrentTask` running:
+```dart
+  task.onTaskComplete(() => .....);
+  task.onFileComplete((String filePath) => .....);
+```
+
+and there is some method to control the `TorrentTask`:
+
+```dart
+   // Stop task:
+   task.stop();
+   // Pause task:
+   task.pause();
+   // Resume task:
+   task.resume();
+```

example/torrent_task_comin_example.dart

@@ -1,7 +1,7 @@
 import 'dart:async';
 
 import 'package:torrent_model/torrent_model.dart';
-import 'package:torrent_task/src/torrent_task.dart';
+import 'package:torrent_task/src/task.dart';
 import 'package:torrent_task/src/utils.dart';
 
 Future<void> main() async {

lib/src/torrent_task.dart lib/src/task.dartlib/src/torrent_task.dart renamed to lib/src/task.dart

@@ -1,2 +1,2 @@
-export 'torrent_task.dart';
+export 'task.dart';
 export 'utils.dart';

lib/src/torrent_task_base.dart

@@ -1,6 +1,3 @@
-/// Support for doing something awesome.
-///
-/// More dartdocs go here.
 library torrent_task;
 
 export 'src/torrent_task_base.dart';

lib/torrent_task_all.dart lib/torrent_task.dartlib/torrent_task_all.dart renamed to lib/torrent_task.dart

@@ -1,6 +1,6 @@
 name: torrent_task
-description: A starting point for Dart libraries or applications.
-version: 1.0.0
+description: Dart library for implement BitTorrent download client.
+version: 0.0.1
 repository: https://github.com/eclipseglory/torrent_task
 issue_tracker : https://github.com/eclipseglory/torrent_task/issues
 publish_to: https://pub.dev/