Skip to content

Commit

Permalink
docs(readme): document setup
Browse files Browse the repository at this point in the history
  • Loading branch information
johnandersen777 committed Nov 29, 2024
1 parent 4c6c0ab commit ef0bcac
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 3 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Git over ATProto

You must install [`deno`](https://docs.deno.com/runtime/getting_started/installation/) due to profile pinned post updating not being available in the Python ATProto client APIs yet.

```bash
python -m pip install gitatp

curl -fsSL https://deno.land/install.sh | sh

git config --global user.email $USER@example.com
git config --global user.atproto $USER.atproto-pds.fqdn.example.com
python -m keyring set $USER@example.com password.$USER.atproto-pds.fqdn.example.com

python -m gitatp --repos-directory $HOME/.local/$USER-gitatp-repos
```

- References
- https://github.com/publicdomainrelay/reference-implementation/issues/15

[![asciicast](https://asciinema.org/a/692702.svg)](https://asciinema.org/a/692702)
9 changes: 6 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
[project]
name = "gitatp"
version = "0.1.5"
version = "0.2.0"
description = "Git over ATProto"
long_description = "[![asciicast](https://asciinema.org/a/692702.svg)](https://asciinema.org/a/692702)"
long_description_content_type = "text/markdown"
readme = {file = "README.md", content-type = "text/markdown"}
authors = [
{ name = "Public Domain", email = "[email protected]" }
]
license = {text = "Unlicense"}
requires-python = ">=3.12"
dependencies = [
"atproto>=0.0.55",
Expand All @@ -16,6 +15,10 @@ dependencies = [
"keyring>=25.5.0",
]

[project.urls]
Repository = "https://github.com/publicdomainrelay/gitatp.git"
Issues = "https://github.com/publicdomainrelay/gitatp/issues"

[project.scripts]
gitatp = "gitatp.cli:main"

Expand Down

0 comments on commit ef0bcac

Please sign in to comment.