Skip to content

Commit

Permalink
[doc] Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ptaoussanis committed Feb 8, 2024
1 parent e1a7c21 commit 22484c5
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,19 @@ See [here][GitHub releases] for earlier releases.

Note that Tempel is [not intended](../../wiki/3-Faq#can-i-decrypt-tempel-data-with-other-tools) for interop with other cryptographic tools/APIs.

## Video demo

See for intro and usage:

<a href="https://www.youtube.com/watch?v=sULZVFhR848" target="_blank">
<img src="https://img.youtube.com/vi/sULZVFhR848/maxresdefault.jpg" alt="Tempel demo video" width="640" border="0" />
</a>

## Documentation

- [Wiki][GitHub wiki] (getting started, usage, etc.)
- API reference: [Codox][Codox docs], [clj-doc][clj-doc docs]

## Roadmap

Tempel has a **fixed scope**, and is **fully complete**. I'm happy with its design and implementation, and believe it meets all its objectives in its current form. I'm not anticipating significant changes.
Expand Down Expand Up @@ -60,11 +73,6 @@ Please be **very careful** evaluating Tempel and/or other cryptographic librarie

See [here](../../security) for **security advisories** and/or to **report security vulnerabilities**.

## Documentation

- [Wiki][GitHub wiki] (getting started, usage, etc.)
- API reference: [Codox][Codox docs], [clj-doc][clj-doc docs]

## Funding

You can [help support][sponsor] continued work on this project, thank you!! 🙏
Expand Down

0 comments on commit 22484c5

Please sign in to comment.