diff --git a/src/routes/+page.svelte b/src/routes/+page.svelte index f9a860b..3581b6f 100644 --- a/src/routes/+page.svelte +++ b/src/routes/+page.svelte @@ -5,13 +5,48 @@
permissionless alternative to GitHub over nostr
++ permissionless alternative to GitHub over nostr +
++ a command-line tool to create, list and apply PRs and patches to git + repositories via nostr events. +
+ It is designed to work seemlessly with this site gitworkshop.dev. + +
+ If you have cargo installed runcargo install ngit.
+ Alternatively download:
+
add the binary to a directory from which it can be run globally.
++ All commands should be run from the directory of the git repository +
++ ngit prs create + use this when you are on a feature branch to propose it gets merged into + the remote branch by repository maintainer. +
++ It creates a PR event and patch events for each commit that isn't + also in the main or master branch. +
++ ngit prs list + fetches a selectable list of open PRs and, if one is selected and the + repository is clean, will create a branch for it and apply the commits. + If the branch already exists it will pull any updates. +
++ ngit pull + if the repository is currently in a branch related to an existing PR, + it will pull any updates from nostr. +
++ ngit push + if the repository is currently in a branch related to an existing PR, + it will create patch events for any new commits. +
++ ngit claim + issue a repository nostr event which lists it on gitworkshop.dev and + indicates you are accepting patches and PRs via nostr. +
++ It also creates an optional maintainers.yaml file in the root of your repo that lists maintainers and relays. If + commited it will make it smoother for contributors to find your repository + event and also makes any future transfer of repository ownership easier. +
+