Merge pull request #32 from kyoto7250/release_crate

Release crate

.github/workflows/ci.yml

@@ -21,6 +21,7 @@ jobs:
   format:
     name: Format
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     steps:
       - uses: actions/checkout@v4
       - name: Cargo fmt
@@ -29,6 +30,7 @@ jobs:
   lint:
     name: Lint
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     steps:
       - uses: actions/checkout@v4
       - name: Cache cargo registry
@@ -54,6 +56,7 @@ jobs:
   unit_tests:
     name: Unit Tests
     runs-on: ${{ matrix.os }}
+    timeout-minutes: 10
     env:
       # For some builds, we use cross to test on 32-bit and big-endian
       # systems.

.github/workflows/release.yml

@@ -9,8 +9,9 @@ jobs:
   release:
     name: Release
     runs-on: ${{ matrix.os }}
+    timeout-minutes: 10
     outputs:
-      zhobo_version: ${{ env.zhobo_VERSION }}
+      zhobo_version: ${{ env.ZHOBO_VERSION }}
     env:
       # For some builds, we use cross to test on 32-bit and big-endian
       # systems.
@@ -50,13 +51,13 @@ jobs:
     steps:
     - name: Get the release version from the tag
       shell: bash
-      if: env.zhobo_VERSION == ''
+      if: env.ZHOBO_VERSION == ''
       run: |
         # Apparently, this is the right way to get a tag name. Really?
         #
         # See: https://github.community/t5/GitHub-Actions/How-to-get-just-the-tag-name/m-p/32167/highlight/true#M1027
-        echo "zhobo_VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV
-        echo "version is: ${{ env.zhobo_VERSION }}"
+        echo "ZHOBO_VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV
+        echo "version is: ${{ env.ZHOBO_VERSION }}"
 
     - name: Checkout repository
       uses: actions/checkout@v2
@@ -102,7 +103,7 @@ jobs:
     - name: Build archive
       shell: bash
       run: |
-        staging="zhobo-${{ env.zhobo_VERSION }}-${{ matrix.target }}"
+        staging="zhobo-${{ env.ZHOBO_VERSION }}-${{ matrix.target }}"
         mkdir -p "$staging"/{complete,doc}
 
         cp {README.md,LICENSE} "$staging/"
@@ -128,10 +129,10 @@ jobs:
   cargo-publish:
     name: Cargo publish
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     needs: release
     steps:
       - uses: actions/checkout@v1
-
       - name: Install cargo-workspaces
         uses: dtolnay/rust-toolchain@stable
         with:
@@ -144,4 +145,4 @@ jobs:
           cargo workspaces publish \
             --yes --force '*' --exact \
             --no-git-commit --allow-dirty --skip-published --token ${{ secrets.CRATES_IO_TOKEN }} \
-            custom ${{ needs.release.outputs.zhobo_version }}
+            custom ${{ needs.release.outputs.ZHOBO_VERSION }}

Cargo.toml

@@ -9,6 +9,8 @@ repository = "https://github.com/kyoto7250/zhobo"
 readme = "README.md"
 description = "A cross-platform TUI database viewer written in Rust. Personally maintained gobang project"
 exclude = ["resources/"]
+keywords = ["database", "cli", "Rust"]
+categories = ["command-line-utilities"]
 
 [dependencies]
 ratatui = { version = "0.26.3" }

README.md

@@ -8,16 +8,18 @@
 - Intuitive keyboard only control
 
 ## Additional Features
-- [ ] custom keymap.
-- [ ] support unix domain.
-- [ ] sort based on specific columns.
-- [ ] fix some bugs.
+- [x] custom keymap.
+- [x] support unix domain.
+- [x] sort based on specific columns.
 
 ## installation
 
 ## homebrew
 
 ## cargo
+```bash
+cargo install zhobo
+```
 
 ## default keymap