Skip to content

Commit e4c576b

Browse files
Update README.md
1 parent c310d47 commit e4c576b

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,29 +51,37 @@ we would love to see your contribution! ❤️
5151

5252
## External recipes
5353

54-
You can register external JARs to extend `allwrite` with additional recipes from any URL.
54+
You can add external recipes to your local `allwrite`, they can be closed-source and stored in a private artifact repository.
5555

56-
Add an external recipe JAR:
56+
All you need to do:
57+
- package your recipes to a JAR file
58+
- publish it somewhere
59+
- grab the URL to the published JAR
60+
- register that URL via `allwrite external add ...`
61+
62+
### Commands for external recipes
63+
64+
Add an external recipes JAR:
5765
```bash
5866
allwrite external add custom-recipes https://repo.com/custom-recipes-1.0.0.jar
5967
```
6068

61-
Update an external recipe JAR with a new URL:
69+
Update an external recipes JAR with a new URL:
6270
```bash
6371
allwrite external update custom-recipes https://repo.com/custom-recipes-2.0.0.jar
6472
```
6573

66-
Re-fetch an external recipe JAR from its stored URL:
74+
Re-fetch an external recipes JAR (useful for SNAPSHOT versions):
6775
```bash
6876
allwrite external update custom-recipes
6977
```
7078

71-
List all registered external recipe JARs:
79+
List external recipes JARs:
7280
```bash
7381
allwrite external ls
7482
```
7583

76-
Remove an external recipe JAR:
84+
Remove an external recipes JAR:
7785
```bash
7886
allwrite external rm custom-recipes
7987
```

0 commit comments

Comments
 (0)