Doc improvement

.pre-commit-config.yaml

@@ -7,6 +7,7 @@ repos:
     rev: v8.18.2
     hooks:
       - id: gitleaks
+        stages: [commit]
 
   - repo: local
     hooks:
@@ -18,20 +19,17 @@ repos:
         args: [--fixup, --wip, --commit-file]
         stages: [commit-msg]
 
-      - id: fmt
-        name: Lint Check
-        entry: cargo
+      - id: typos
+        name: Check for typos
+        entry: typos
         language: system
         files: .*
-        args: [fmt, --check]
-        pass_filenames: false
         stages: [commit]
 
+  - repo: https://github.com/FeryET/pre-commit-rust
+    rev: v1.1.0
+    hooks:
+      - id: fmt
+        stages: [commit]
       - id: clippy
-        name: Check clippy suggestions
-        entry: cargo
-        language: system
-        files: .*
-        args: [clippy]
-        pass_filenames: false
         stages: [commit]

README.md

@@ -6,17 +6,23 @@ This programs makes use of x-scheme-handler to open the program that is currentl
 
 # Example installation
 
-## Using cargo
+### Using cargo
 
-### From crates.io
+#### From crates.io
 
 Execute `cargo install rofi-obsidian`
 
-### From source
+#### From source
 
 Clone the repository and execute `cargo install`
 
-## Manually
+### Using Nix Flakes
+
+```sh
+nix profile install github:Nydragon/rofi-obsidian
+```
+
+### Manually
 
 Either add the binary to your $PATH environment variable or move it into the $XDG_CONFIG_HOME/rofi/scripts folder.
 

flake.nix

@@ -24,7 +24,7 @@
           rustc = rustVersion;
         };
 
-        myRustBuild = rustPlatform.buildRustPackage {
+        rofi-obsidian-pkg = rustPlatform.buildRustPackage {
           pname = manifest.name;
           version = manifest.version;
           src = ./.;
@@ -38,15 +38,18 @@
         };
       in
       {
-        packages = {
-          rustPackage = myRustBuild;
+        packages = rec {
+          rofi-obsidian = rofi-obsidian-pkg;
+          default = rofi-obsidian;
         };
-        defaultPackage = myRustBuild;
-        devShell = pkgs.mkShell {
+
+        devShells.default = pkgs.mkShell {
           buildInputs = [
             (rustVersion.override { extensions = [ "rust-src" ]; })
             pkgs.git-cliff
             pkgs.committed
+            pkgs.pre-commit
+            pkgs.typos
           ];
           shellHook =
             let
@@ -55,15 +58,18 @@
               bin = "rofi-obsidian";
               rofiDebug = "rofi-obsidian-debug";
               rofiRelease = "rofi-obsidian-release";
+              RED = "\\033[0;31m";
+              NC = "\\033[0m";
             in
             ''
               alias ${rofiDebug}="${cargo} build && ${rofi} -show o -modes o:./target/debug/${bin}"
               alias ${rofiRelease}="${cargo} build --profile release && ${rofi} -show o -modes o:./target/release/${bin}"
+              ${pkgs.pre-commit}/bin/pre-commit install -f
 
-              echo "Use ${rofiDebug} to build and run the debuging version with rofi."
+              printf "\n${RED}INFO -----------${NC}\n\n";
+              echo "Use ${rofiDebug} to build and run the debugging version with rofi."
               echo "Use ${rofiRelease} to build and run the release version with rofi."
-
-              ${pkgs.pre-commit}/bin/pre-commit install -f
+              printf "\n${RED}INFO -----------${NC}\n\n";
             '';
         };
       }