about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorGenny <gen@nyble.dev>2020-10-06 20:20:03 -0500
committerGenny <gen@nyble.dev>2020-10-06 20:20:03 -0500
commit212c5b304328ec4d66f7e6b9c91bd65154918fff (patch)
tree7d344864bcd5509a381f6dc86701b4317204cdd4 /README.md
parent4dfa8fa22bc70c96adc902ded4b8795cab061627 (diff)
downloadgifed-212c5b304328ec4d66f7e6b9c91bd65154918fff.tar.gz
gifed-212c5b304328ec4d66f7e6b9c91bd65154918fff.zip
Get ready for first publish
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4b20d98
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# gifed
+Gifed is a **GIF** **e**ncoding and **d**ecoding library.
+
+At current, half of that statement is a lie and this crate is incredibly rough. This library can
+only *write* gifs. The project is in its infancy but I hope to make it feature complete and
+intuitive to use while wtill allowing fine grained control over the file itself, which has been and 
+always will be, one of the main goals of this crate.
+
+### Features
+- [x] Writing GIF87a
+- [ ] Writing GIF89a
+- [ ] Automatically select the lowest version possible when writing
+- [ ] Read GIF87a
+- [ ] Read GIF89a
+- [ ] Feature to allow using [weezl][weezl-crates] for LZW compression instead of the built-in
+
+[weezl-crates]: https://crates.io/crates/weezl
\ No newline at end of file