Skip to content

Commit da03a07

Browse files
docs: add development version installation guide and usage guidelines
1 parent 670c09b commit da03a07

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,36 @@ Full documentation can be found [here](https://docs.taco.build/).
1616
pnpm add @nucypher/taco
1717
```
1818

19+
### Development Versions
20+
21+
For testing features from `epic-**` branches before they're officially released, you can install development versions published with the `dev` tag:
22+
23+
```bash
24+
pnpm add @nucypher/taco@dev
25+
pnpm add @nucypher/taco-auth@dev
26+
pnpm add @nucypher/shared@dev
27+
```
28+
29+
**Development version format:**
30+
```
31+
{next-version}-dev.{branch-name}.{date}.{commit-hash}.{build-number}
32+
```
33+
34+
**Example:**
35+
```
36+
1.2.4-dev.epic-new-feature.20250120.aeed464a.17
37+
```
38+
39+
**When to use dev versions:**
40+
- ✅ Testing new features from epic branches which contains pre-release functionality
41+
- ✅ Providing feedback on unreleased features
42+
43+
**When NOT to use dev versions:**
44+
- ❌ Production environments
45+
- ❌ Stable development work
46+
47+
**Note:** Dev versions are automatically published when code is merged to `epic-**` branches and sometimes manually published. These versions are unstable and may contain breaking changes or even sometimes broken code.
48+
1949
## Tutorial
2050

2151
To learn more, follow the tutorial at Threshold

0 commit comments

Comments
 (0)