diff --git a/README.md b/README.md index cd593e74..b32a9b15 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ Automate reproducible packaging for various language ecosystems
Documentation | - Example Repo - Example Modules + Example Repo | + Example Packages

!!! Warning: dream2nix is unstable software. While simple UX is one of our main focus points, the APIs are still under development. Do expect changes that will break your setup. diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 1ec5bb7e..ceac12ee 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,7 +1,12 @@ - [Introduction](./intro.md) -# concepts + +# Examples +- [dream2nix examples](./examples.md) +# Concepts - [dream2nix modules](./modules.md) + +# Drafts - [DRAFT (outdated): modules based API](./v1-api/summary.md) - [problems of the legacy dream2nix](./v1-api/problems.md) - [users of dream2nix](./v1-api/users.md) diff --git a/docs/src/examples.md b/docs/src/examples.md new file mode 100644 index 00000000..98158d12 --- /dev/null +++ b/docs/src/examples.md @@ -0,0 +1,4 @@ +# Examples for dream2nix + +- [👉 example repository](https://github.com/nix-community/dream2nix/tree/main/examples/dream2nix-repo) +- [👉 example packages](https://github.com/nix-community/dream2nix/tree/main/examples)