Skip to content

Commit dcf05e6

Browse files
authored
feat: update README.md (#3)
1 parent 1dd990a commit dcf05e6

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed
File renamed without changes.

Makefile

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,6 @@ setup_dev:
1414
assert_setup_dev:
1515
pre-commit run -a
1616

17-
ci:
18-
chmod +x common/install_brew_packages.sh
19-
./common/install_brew_packages.sh
20-
2117
lint:
2218
find . -type f -name "*.sh" -exec shfmt -w -i 6 {} +
2319
find . -type f -name "*.sh" -exec shellcheck {} +

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# Shared Scripts
22

3-
Quick-share command line scripts for use in quick command runner like Makefile or Justfile.
3+
This repository contains reusable shell scripts intended for use with quick command runners like Makefile or Justfile.
4+
It is designed to be added as a Git submodule in other projects.
45

56
## Quick Start
67

78
```bash
8-
make setup_dev # Install all dependencies and setup development environment
9-
make assert_setup_dev # Validate setup
9+
make setup_dev
10+
make assert_setup_dev
1011
```
1112

1213
## Requirements
@@ -17,10 +18,14 @@ make assert_setup_dev # Validate setup
1718

1819
## Usage
1920

21+
- Add as Submodule
22+
2023
```bash
2124
git submodule add -b main https://github.com/wisarootl/shared-scripts.git scripts/shared
2225
```
2326

27+
- Example Makefile Usage
28+
2429
```Makefile
2530
setup_dev:
2631
chmod +x scripts/shared/node/setup_dev.sh

0 commit comments

Comments
 (0)