Separate lib/bin, update README.md, release v1.0.0

Author: encounter

.github/workflows/build.yaml

@@ -14,7 +14,7 @@ jobs:
       RUSTFLAGS: -D warnings
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Rust toolchain
         uses: dtolnay/rust-toolchain@stable
         with:
@@ -35,7 +35,7 @@ jobs:
     # Prevent new advisories from failing CI
     continue-on-error: ${{ matrix.checks == 'advisories' }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: EmbarkStudios/cargo-deny-action@v1
         with:
           command: check ${{ matrix.checks }}
@@ -49,7 +49,7 @@ jobs:
     runs-on: ${{ matrix.platform }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Rust toolchain
         uses: dtolnay/rust-toolchain@stable
       - name: Cargo test
@@ -87,7 +87,7 @@ jobs:
     runs-on: ${{ matrix.platform }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install dependencies
         if: matrix.packages != ''
         run: sudo apt-get -y install ${{ matrix.packages }}
@@ -98,7 +98,7 @@ jobs:
       - name: Cargo build
         run: cargo build --release --all-features --target ${{ matrix.target }} --bin ${{ env.CARGO_BIN_NAME }}
       - name: Upload artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ matrix.name }}
           path: |
@@ -115,7 +115,7 @@ jobs:
     needs: [ build ]
     steps:
       - name: Download artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           path: artifacts
       - name: Rename artifacts
@@ -127,6 +127,6 @@ jobs:
           done
           ls -R ../out
       - name: Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         with:
           files: out/*

.gitignore

@@ -1,3 +1,3 @@
-/target
+target/
 Cargo.lock
 .idea

Cargo.toml

@@ -1,16 +1,3 @@
-[package]
-name = "cwdemangle"
-version = "0.2.0"
-edition = "2018"
-authors = ["Luke Street <[email protected]>"]
-license = "MIT OR Apache-2.0"
-repository = "https://github.com/encounter/cwdemangle"
-readme = "README.md"
-description = """
-CodeWarrior C++ symbol demangler
-"""
-categories = ["command-line-utilities"]
-rust-version = "1.58"
-
-[dependencies]
-argh = "0.1.8"
+[workspace]
+members = ["lib", "bin"]
+resolver = "2"

README.md

@@ -10,24 +10,37 @@
 
 A CodeWarrior C++ symbol demangler.
 
-### Usage
+## Usage
 
-CLI:
+### CLI
+
+Static binaries available from [releases](https://github.com/encounter/cwdemangle/releases) or install via `cargo install cwdemangle-bin`.
 
 ```shell
 cwdemangle 'BuildLight__9CGuiLightCFv'
 ```
 
-Library:
+Pass `--help` to see available options.
+
+### Library
+
+- No dependencies
+- `#![no_std]` compatible (requires `alloc`)
+
+Cargo.toml:
+
+```toml
+[dependencies]
+cwdemangle = "0.2"
+```
+
+Usage:
 
 ```rust
 use cwdemangle::{demangle, DemangleOptions};
 
-if let Some(result) = demangle("BuildLight__9CGuiLightCFv", &DemangleOptions::default()) {
-    println!("{}", result);
-} else {
-    eprintln!("Couldn't demangle symbol (not a C++ symbol?)");
-}
+let result = demangle("BuildLight__9CGuiLightCFv", &DemangleOptions::default());
+assert_eq!(result, Some("CGuiLight::BuildLight() const".to_string()));
 ```
 
 ### License

bin/Cargo.toml

@@ -0,0 +1,19 @@
+[package]
+name = "cwdemangle-bin"
+version = "1.0.0"
+edition = "2021"
+authors = ["Luke Street <[email protected]>"]
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/encounter/cwdemangle"
+readme = "../README.md"
+description = "CodeWarrior C++ symbol demangler (binary)"
+categories = ["command-line-utilities"]
+rust-version = "1.58"
+
+[[bin]]
+name = "cwdemangle"
+path = "src/main.rs"
+
+[dependencies]
+argh = "0.1.12"
+cwdemangle = { path = "../lib" }