Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kaisellgren committed Aug 15, 2012
1 parent 040ca11 commit c73efb3
Showing 1 changed file with 32 additions and 3 deletions.
35 changes: 32 additions & 3 deletions README.md
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.

0 comments on commit c73efb3

Please sign in to comment.