forked from kaisellgren/DartZip
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
040ca11
commit c73efb3
Showing
1 changed file
with
32 additions
and
3 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,6 +1,35 @@ | ||
DartZip | ||
== | ||
A Zib library written in Dart. | ||
A Zib library written in [Dart](http://dartlang.org). | ||
|
||
## License | ||
The library is licensed under MIT. | ||
### Notes | ||
|
||
This library is in progress, and can partially extract Zip files. To be more specific, it can extract non-compressed Zip files | ||
such as Zip files containing small text files (they are rarely compressed). | ||
|
||
### Installation | ||
|
||
For now, until the Dart package manager is finished, just clone the repository. | ||
|
||
### Examples | ||
|
||
The following code extracts the `test.zip` file to the given target folder. It works as long as the Zip file does not contain compressed files. | ||
|
||
```dart | ||
#import('../lib/Zip.dart'); | ||
#import('dart:io'); | ||
void main() { | ||
var currentPath = new Directory.current().path; | ||
var zip = new Zip(new Path('test.zip')); | ||
zip.extractTo(new Path.fromNative("${currentPath}/test-extraction/")); | ||
} | ||
``` | ||
|
||
### TODO | ||
|
||
Support for compressed files is the next priority. Even after that, there's still work to do regarding signatures, encryption and other minor things. | ||
|
||
### License | ||
The library is licensed under MIT. Feel free to use it for any purpose. |