@bshsolutions/git 0.0.1-alpha → 0.0.2-alpha
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.
- package/README.md +14 -30
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,41 +1,25 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @bshsolutions/git
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[](https://github.com/bsh-devsolutions/git.bsh)
|
|
5
|
-
|
|
6
|
-
A small **Node.js CLI** for everyday Git workflows: quick **`hello`** checks and a **`commit`** command that can install a **`commit-msg`** hook so messages stay consistent.
|
|
7
|
-
|
|
8
|
-
| | |
|
|
9
|
-
| --- | --- |
|
|
10
|
-
| **Binary** | `git` |
|
|
11
|
-
| **Package** | [`@bshsolutions/git`](https://www.npmjs.com/package/@bshsolutions/git) |
|
|
3
|
+
> A friendly CLI for common Git workflows.
|
|
12
4
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
## Features
|
|
5
|
+
[](https://opensource.org/licenses/MIT)
|
|
16
6
|
|
|
17
|
-
|
|
18
|
-
- **Structured commits** — validate messages and optionally enforce them via a Git hook.
|
|
19
|
-
- **`npx`-first** — run without a global install, or `npm link` for local development.
|
|
7
|
+
## Usage
|
|
20
8
|
|
|
21
|
-
|
|
9
|
+
```sh
|
|
10
|
+
npx @bshsolutions/git --help
|
|
11
|
+
```
|
|
22
12
|
|
|
23
13
|
## Documentation
|
|
24
14
|
|
|
25
|
-
docs/
|
|
26
|
-
- `├──` [**Documentation home**](docs/README.md)
|
|
27
|
-
- `├──` [**Setup**](docs/setup.md)
|
|
28
|
-
- `├──` [**Commands**](docs/commands.md)
|
|
29
|
-
- `└──` [**Commit**](docs/commit.md)
|
|
15
|
+
Full guides live in the repo: [docs](docs/README.md) (setup, commands, commit flow).
|
|
30
16
|
|
|
31
|
-
|
|
17
|
+
## Links
|
|
32
18
|
|
|
33
|
-
|
|
19
|
+
- [npm](https://www.npmjs.com/package/@bshsolutions/git)
|
|
20
|
+
- [Repository](https://github.com/bsh-devsolutions/git.bsh)
|
|
21
|
+
- [Issues](https://github.com/bsh-devsolutions/git.bsh/issues)
|
|
34
22
|
|
|
35
|
-
|
|
36
|
-
npm install
|
|
37
|
-
npm run build
|
|
38
|
-
npx @bshsolutions/git hello --name you
|
|
39
|
-
```
|
|
23
|
+
## License
|
|
40
24
|
|
|
41
|
-
|
|
25
|
+
MIT
|