add some examples and resources
This commit is contained in:
25
README.md
25
README.md
@@ -13,6 +13,31 @@ def deps do
|
||||
end
|
||||
```
|
||||
|
||||
## Decoding Example
|
||||
|
||||
create a zip file
|
||||
|
||||
```sh
|
||||
cd /tmp
|
||||
echo test > test
|
||||
zip test.zip test
|
||||
```
|
||||
|
||||
extract information
|
||||
|
||||
```elixir
|
||||
{:ok, file} = :file.read_file("/tmp/test.zip")
|
||||
Dotzip.decode(file)
|
||||
```
|
||||
|
||||
## Resources
|
||||
|
||||
* https://www.loc.gov/preservation/digital/formats/fdd/fdd000362.shtml
|
||||
* https://pkware.cachefly.net/webdocs/APPNOTE/APPNOTE-6.3.3.TXT
|
||||
* https://en.wikipedia.org/wiki/ZIP_(file_format)
|
||||
|
||||
## Notes
|
||||
|
||||
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
|
||||
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
|
||||
be found at [https://hexdocs.pm/dotzip](https://hexdocs.pm/dotzip).
|
||||
|
||||
Reference in New Issue
Block a user