Skip to content

Commit

Permalink
docs: README init
Browse files Browse the repository at this point in the history
  • Loading branch information
EthnTuttle committed Nov 12, 2023
1 parent 3f29440 commit 4a98f2a
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 10 deletions.
5 changes: 0 additions & 5 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions modules/nostrmint-client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# nostrmint-client

See [`../nostrmint-common/README.md`](../nostrmint-common/README.md)
12 changes: 7 additions & 5 deletions modules/nostrmint-common/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# nostrmintYou can list message requests: fedimint-cli list-note-requests
# nostrmint

Since the npub is for the fedimint itself, we limit nostr interaction to authenticated guardians `export FM_PASSWORD=pass`

You can list message requests: `fedimint-cli nostr list-note-requests`

You can create note requests: `fedimint-cli nostr text-note --msg "My FROST Message"`

You can create note requests: fedimint-cli create-note --msg "My FROST Message" --peer-id 0
That will only work if you've previously set FM_PASSWORD: export FM_PASSWORD=pass
Then you should see the message request pop up using the list command
Then you can use the other guardians to sign: fedimint-cli sign-note --event-id <EVENT_ID> --peer-id 1
That will only work if you have FM_PASSWORD set correctly for peer 1. In tmuxinator all passwords are the same so you only need to do it once

Expand All @@ -11,7 +14,6 @@ you can get the npub of the federation: fedimint-cli get-npub
Then signin to snort.social or something and you should see the note
Give it a try and let me know if you get it to work. It's really rough right now but it works!


## Running it

## How it works?
Expand Down
3 changes: 3 additions & 0 deletions modules/nostrmint-server/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# nostrmint-server

See [`../nostrmint-common/README.md`](../nostrmint-common/README.md)

0 comments on commit 4a98f2a

Please sign in to comment.