git-ward 0.1.3 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/Cargo.toml +1 -1
  2. package/README.md +26 -0
  3. package/package.json +3 -2
package/Cargo.toml CHANGED
@@ -1,6 +1,6 @@
1
1
  [package]
2
2
  name = "ward"
3
- version = "0.1.3"
3
+ version = "0.1.5"
4
4
  edition = "2021"
5
5
  authors = ["awixor"]
6
6
  description = "Local-First Git Guard for preventing secret leaks"
package/README.md CHANGED
@@ -62,6 +62,28 @@ You can also run a scan manually without committing:
62
62
  ward scan
63
63
  ```
64
64
 
65
+ ## 🗑 Uninstallation
66
+
67
+ To remove the Git hook:
68
+
69
+ ```bash
70
+ # Run this in your repo root
71
+ rm .git/hooks/pre-commit
72
+ # Or if you have other hooks, edit .git/hooks/pre-commit and manually remove the ward lines
73
+ ```
74
+
75
+ ## 🤖 CI/CD Integration
76
+
77
+ You can run Ward in your CI pipeline to prevent secrets from being merged.
78
+
79
+ ### GitHub Actions
80
+
81
+ ```yaml
82
+ steps:
83
+ - uses: actions/checkout@v3
84
+ - run: npx git-ward scan
85
+ ```
86
+
65
87
  ## ⚙️ Configuration (`ward.toml`)
66
88
 
67
89
  Create a `ward.toml` in your project root to customize behavior:
@@ -87,6 +109,10 @@ generated/
87
109
  *.log
88
110
  ```
89
111
 
112
+ ## 🤝 Contributing
113
+
114
+ Contributions are welcome! Please open an issue or submit a PR on GitHub.
115
+
90
116
  ## License
91
117
 
92
118
  MIT
package/package.json CHANGED
@@ -1,9 +1,10 @@
1
1
  {
2
2
  "name": "git-ward",
3
- "version": "0.1.3",
3
+ "version": "0.1.5",
4
4
  "description": "Local-First Git Guard for preventing secret leaks",
5
5
  "bin": {
6
- "ward": "./bin/ward.js"
6
+ "ward": "./bin/ward.js",
7
+ "git-ward": "./bin/ward.js"
7
8
  },
8
9
  "scripts": {
9
10
  "test": "echo \"Error: no test specified\" && exit 1",