Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe repo contents in README #96

Merged
merged 6 commits into from
Feb 19, 2025
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
# Aranya Core

This repo is a cargo workspace for the Rust implementation for the core of the Aranya platform.
Aranya is lovingly crafted and supported by [SpiderOak](https://spideroak.com/).
Aranya is licensed under the [AGPL](LICENSE.md)- if you want to use it
commercially, drop us a line!

More documentation on Aranya is provided here: [Aranya Documentation](https://aranya-project.github.io/aranya-docs/).
## What's Contained In This Repo

# Contributing
This repo is a cargo workspace for the Rust implementation for the core of the
Aranya platform. This is a library that includes the storage module (for DAG
and FactDB), crypto module (with default crypto engine automatically selected),
sync engine, and runtime client (including policy VM).

Our `CONTRIBUTING.md` is located in the aranya-project organization's `.github` repo:
[CONTRIBUTING.md](https://github.com/aranya-project/.github/blob/main/CONTRIBUTING.md)
Additionally, includes [Aranya Fast Channels](crates/aranya-fast-channels/) to
enable encrypted channels between 2 peers allowing either unidirectional or
bidirectional communication.

More documentation on Aranya is provided here:
[Aranya Documentation](https://aranya-project.github.io/aranya-docs/).

## Cargo Make

Expand Down Expand Up @@ -38,3 +47,12 @@ makers unit-tests
# run correctness checks
makers correctness
```

## Contributing

Find information on contributing to the Aranya project in
[`CONTRIBUTING.md`](https://github.com/aranya-project/.github/blob/main/CONTRIBUTING.md).

## Maintainers

This repository is maintained by software engineers employed at [SpiderOak](https://spideroak.com/)
Loading