Skip to content

Commit

Permalink
Cleanup readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chmac committed Aug 11, 2024
1 parent 8f45f72 commit 2997638
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,29 @@ Read and leave **nostr notes on a map**.

This is running at [notes.trustroots.org](https://notes.trustroots.org/). And it is part of our effort to [nostrify trustroots](https://github.com/Trustroots/nostroots).


## Getting started

- Install node and yarn
- Install nvm
- `nvm install` - This is only required one time
- `nvm use`

Then run yarn from corepack. There are 2 ways to do this. If you have yarn
installed globally, you can uninstall it. Or you can run `corepack yarn` instead
of `yarn`.

- `yarn`
- `yarn start`
- Open http://localhost:1234

It seems that newer node versions [don't work](https://github.com/Trustroots/nostr-map/issues/21) don't work. You may have to run this to use node v18:
- `nvm install`
- `nvm use`

You might need `corepack` to get yarn v4. [please update/clarify this]

## Ideas

somewhat concrete:

- [filters](https://github.com/Trustroots/nostr-map/issues/13)
- [chat](https://github.com/Trustroots/nostr-map/issues/14)

vague-ish:

- rideshare related tags
- update location with regular interval
- hashtags, e.g. for circles or events, #hg24 for hitchgathering 2024?

0 comments on commit 2997638

Please sign in to comment.