https://github.com/adamdecaf/nostr-book

NIPs compiled into a book
https://github.com/adamdecaf/nostr-book

nips nostr nostr-client nostr-protocol nostr-relay

Last synced: 2 months ago
JSON representation

NIPs compiled into a book

• Host: GitHub
• URL: https://github.com/adamdecaf/nostr-book
• Owner: adamdecaf
• License: unlicense
• Created: 2024-05-09T19:15:25.000Z (7 months ago)
• Default Branch: master
• Last Pushed: 2024-05-22T20:32:36.000Z (7 months ago)
• Last Synced: 2024-05-22T20:38:15.540Z (7 months ago)
• Topics: nips, nostr, nostr-client, nostr-protocol, nostr-relay
• Language: Shell
• Homepage: https://nostr-book.org
• Size: 3.09 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nostr - nostr-book - book.svg?style=social) - NIPs compiled into a book (Other links / Client reviews and/or comparisons)

README

        
# nostr-book

[NIPs](https://github.com/nostr-protocol/nips) consolidated and organized into a readable book format.

## Get the Book

nostr-book is available in [ePUB](https://github.com/adamdecaf/nostr-book/raw/master/nostr-book.epub) or [PDF](https://github.com/adamdecaf/nostr-book/raw/master/nostr-book.pdf).

## Contributing

Display or style improvements are welcome! The text is almost entirely pulled from the [NIPs repository](https://github.com/nostr-protocol/nips) and left unchanged. Improvements to a NIP should be made upstream.

## Development

You'll need to [install pandoc](https://github.com/jgm/pandoc/blob/main/INSTALL.md) and install basictex (`brew install basictex` on macOS).

To download the NIPs run `make setup`. Then you'll be able to generate the output formats.

```

make epub

```

```

make pdf

```

## License

The code to generate nostr-book is released in the Public Domain. Content from NIPs follows the license of [nostr-protocol/nips](https://github.com/nostr-protocol/nips).