Skip to content

Commit

Permalink
docs: Update README and add logo
Browse files Browse the repository at this point in the history
  • Loading branch information
jimouris committed Apr 30, 2024
1 parent f3f6998 commit a092a02
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
<h1 align="center">Ripple
<a href="https://github.com/NillionNetwork/ripple/actions/workflows/ci-build.yml"><img src="https://github.com/NillionNetwork/ripple/workflows/ci-build/badge.svg"></a>
<a href="https://github.com/NillionNetwork/ripple/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg"></a>

<img src="./assets/ripple.png" height="20%" width="20%">
</h1>


# Building

For `x86_64`-based machines running Unix-like OSes:
Expand All @@ -17,7 +20,11 @@ For Apple Silicon or `aarch64`-based machines running Unix-like OSes:

# Running

...
```bash
❯❯ cargo run --release --bin correlation
❯❯ cargo run --release --bin euclidean
❯❯ cargo run --release --bin lr
```

## Disclaimer
This is software for a research prototype and not production-ready code.
Binary file added assets/ripple.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a092a02

Please sign in to comment.