Fix format for inkscape

Author: JoshBashed

.github/workflows/rust-test.yml renamed to .github/workflows/ci.yml

@@ -3,9 +3,7 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 on:
-  pull_request:
-    paths:
-      - icns-rs/**
+  pull_request: null
   push: null
   workflow_dispatch: null
 jobs:
@@ -20,14 +18,10 @@ jobs:
           toolchain: stable
           override: true
       - name: Run tests
-        working-directory: ./icns-rs
         run: cargo test
   rustfmt:
     name: Rustfmt
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./icns-rs
     steps:
       - uses: actions/checkout@v3
       - name: Setup Rust
@@ -37,5 +31,4 @@ jobs:
           override: true
           components: rustfmt
       - name: Run rustfmt
-        working-directory: ./icns-rs
         run: cargo fmt -- --check

.github/workflows/rust-publish.yml renamed to .github/workflows/publish.yml

@@ -1,8 +1,7 @@
 name: Cargo Publish
 on:
   push:
-    tags:
-      - rust-*
+    tags: '*'
   workflow_dispatch: null
 jobs:
   publish:
@@ -16,5 +15,4 @@ jobs:
           toolchain: stable
           override: true
       - name: Publish
-        run: cargo publish --token ${{ secrets.CRATES_TOKEN }}
-        working-directory: ./icns-rs
+        run: cargo publish --token ${{ secrets.CRATES_TOKEN }}

.gitignore

@@ -0,0 +1,3 @@
+# Cargo
+target/
+Cargo.lock

icns-rs/Cargo.toml renamed to Cargo.toml

@@ -1,12 +1,12 @@
 [package]
 name = "icns-rs"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 description = "A library for reading and writing Apple Icon Image (.icns) files."
 license = "LGPL-3.0-or-later"
 homepage = "https://github.com/JoshuaBrest/icns/tree/master/icns-rs"
 documentation = "https://docs.rs/icns-rs"
-repository = "https://github.com/JoshuaBrest/icns"
+repository = "https://github.com/JoshuaBrest/icns-rs"
 catagories = ["image"]
 keywords = ["icns", "image", "apple", "icon"]
 

README.md

@@ -1,12 +1,74 @@
-# ICNS
+# icns-rs
 
-This repository contains a multiple libraries for reading and writing ICNS files.
-  - Rust: [icns-rs](icns-rs/README.md) 
+The ICNS format is a file format used by Apple to store icons for macOS applications. This crate provides a simple API for reading and (and soon)writing ICNS files.
+
+## Roadmap
+
+- [x] Write ICNS files
+- [ ] Read ICNS files
+
+## Usage
+
+Here's a simple example of how to read an ICNS file:
+
+> You can find this example in `examples/encode.rs` or run it with:
+> ```sh
+> cargo run --example encode
+> ```
+
+```rust
+use std::fs::File;
+use std::io::prelude::*;
+use image::open;
+use icns_rs::{IcnsEncoder, IconFormats};
+
+fn main() -> std::io::Result<()> {
+    // Open the image
+    let image = match open("example.png") {
+        Ok(image) => image,
+        Err(e) => {
+            println!("Error opening file: {}", e);
+            return Ok(());
+        }
+    };
+
+    // Create the encoder
+    let mut encoder = IcnsEncoder::new();
+
+    encoder.data(image);
+    encoder.formats(IconFormats::recommended());
+
+    // Encode the image
+    let data = match encoder.build() {
+        Ok(data) => data,
+        Err(e) => {
+            println!("Error encoding image: {}", e);
+            return Ok(());
+        }
+    };
+
+    // Write data to file
+    let mut file = File::create("example.icns")?;
+    file.write_all(&data)?;
+
+    Ok(())
+}
+```
+
+## License
+
+This project is licensed under the GPLv3 license. See the [LICENSE](LICENSE) file for more details.
 
 ## Contributing
 
 Contributions are welcome! Feel free to open an issue or submit a pull request.
 
-## License
+## Acknowledgements
+
+This project is heavily inspired by:
+  - The Python package: [icnsutil](https://github.com/relikd/icnsutil/)
+  - The JavaScript package: [@fiahfy/icns](https://github.com/fiahfy/icns/)
+  - The JavaScript PackBits implementation: [@fiahfy/packbits](https://github.com/fiahfy/packbits/)
+  - The Wikipedia page: [Wikipedia: Apple Icon Image Format](https://en.wikipedia.org/wiki/Apple_Icon_Image_format#Icon_types)
 
-This project is licensed under the LGPLv3 license. See the [LICENSE](/LICENSE) file for more details.
+When I started building this, I didn't know there already was a ICNS lib for rust, but, after looking at it, it was not up to my standards because of the lack of ARGB, RGB, and, Mask support. I wanted to create a modern package that was easy to use and had a simple API. I also wanted to make sure that it was well documented and had a good test suite. I hope you enjoy using this package as much as I enjoyed making it!.