[build] bump to major release v0.1.1 → v1.0.0 (#12)

* [ci/cd] github cd workflow with cargo publish

* [build] bump to major version v0.1.1 → v1.0.0

* [fix] syntax error in example docs

* [fix] missing name on cd step

* [fix] cargo fmt and clippy lint changes

.github/workflows/cd.yml

@@ -0,0 +1,30 @@
+name: CD
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+  deploy:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest ]
+        rust: [ stable ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: ${{ matrix.rust }}
+          override: true
+      - name: Cargo check
+        uses: actions-rs/cargo@v1
+        with:
+          command: check
+      - name: Cargo publish
+        run: cargo publish --token ${CRATES_TOKEN}
+          env:
+            CRATES_TOKEN: ${{ secrets.CRATES_TOKEN }}

Cargo.toml

@@ -1,8 +1,8 @@
 [package]
 name = "padder"
-version = "0.1.1"
+version = "1.0.0"
 edition = "2021"
-description = "Efficient data formatting and padding, done right, the rusty way."
+description = "Highly efficient data and string formatting library for Rust."
 authors = [
     "Wilhelm Ågren <[email protected]>",
 ]

src/lib.rs

@@ -25,6 +25,7 @@
 * Last updated: 2023-12-19
 */
 
+///
 /// Highly efficient data and string formatting library for Rust.
 ///
 /// Pad and format string slices and generic vectors efficiently with minimal memory
@@ -41,6 +42,7 @@
 /// +---+---+---+        +---+---+---+---+---+---+
 ///
 /// ```
+/// use padder::*;
 /// let output: String = "abc".pad(6, Alignment::Left, Symbol::Whitespace);
 /// ```
 ///