Skip to content

Commit 25b283c

Browse files
committed
Add section to README
1 parent f7ef47e commit 25b283c

File tree

1 file changed

+61
-1
lines changed

1 file changed

+61
-1
lines changed

README.md

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,66 @@ Please generate me a new rule formatted according to prompts/00-rules-template.m
2121

2222
This ensures consistent structure and keeps rules focused and actionable.
2323

24+
# Using as a Git Submodule
25+
26+
To add this library to your existing project with prompts, you can include it as a git submodule. This creates a `library` subdirectory within your `prompts` folder containing all the rules and templates.
27+
28+
## Setup
29+
30+
1. Navigate to your project's `prompts` directory:
31+
```bash
32+
cd prompts
33+
```
34+
35+
2. Add this repository as a submodule named `library`:
36+
```bash
37+
git submodule add https://github.com/EqualExperts/llm-rules.git library
38+
```
39+
40+
3. Initialize and update the submodule:
41+
```bash
42+
git submodule update --init --recursive
43+
```
44+
45+
4. Commit the submodule addition:
46+
```bash
47+
git add .gitmodules library
48+
git commit -m "Add llm-rules as library submodule"
49+
```
50+
51+
## Updating the Library
52+
53+
To pull the latest updates from the library:
54+
55+
```bash
56+
cd prompts/library
57+
git pull origin main
58+
cd ..
59+
git add library
60+
git commit -m "Update llm-rules library"
61+
```
62+
63+
## Structure
64+
65+
After setup, your prompts directory will look something like:
66+
67+
```
68+
prompts/
69+
├── 01-optional_vendor_validation-oneshot.md
70+
├── 01-optional_vendor_validation-todo.md
71+
├── 02-idempotent_post_and_delete-oneshot.md
72+
└── library/
73+
├── rules/
74+
│ ├── domain-driven-design.md
75+
│ ├── hexagonal-architecture.md
76+
│ ├── kotest.md
77+
│ └── kotlin.md
78+
└── templates/
79+
├── 00-oneshot_template.md
80+
├── 00-rules-template.md
81+
└── 00-todo_template.md
82+
```
83+
2484
# Prompts
2585

26-
Prompt templates and snippets
86+
Prompt templates and snippets

0 commit comments

Comments
 (0)