Skip to content

Commit

Permalink
docs: update readme to include more information
Browse files Browse the repository at this point in the history
* docs: update readme to include more information

* docs: add new line to the bottom

Signed-off-by: Green <[email protected]>

---------

Signed-off-by: Green <[email protected]>
Co-authored-by: jake <[email protected]>
  • Loading branch information
greendoescode and brxken128 authored May 28, 2024
1 parent 697dabf commit 2bf1447
Showing 1 changed file with 38 additions and 2 deletions.
40 changes: 38 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,41 @@
# Volaris
![GitHub License](https://img.shields.io/github/license/volarisapp/Volaris) ![GitHub Issues](https://img.shields.io/github/issues/volarisapp/Volaris) ![GitHub Stars](https://img.shields.io/github/stars/volarisapp/Volaris)

A modern, secure Rust-based encryption tool for desktops, CLI interfaces and even mobile devices.
## Introduction

**Privacy and security come first**.
Volaris is an encryption tool designed to prioritize privacy and security. Built using Rust, it offers a modern and efficient solution for securing your data across multiple platforms, including desktops, command-line interfaces (CLI), and mobile devices.

## Features

- **Cross-Platform Support**: Available on desktop, CLI, and mobile devices.
- **Rust-Based Security**: Leveraging Rust’s safety and performance features.
- **Modern Encryption Standards**: Uses the latest encryption algorithms to ensure data security.

## Current Status

Volaris is currently in development. We are working hard to bring you a secure and user-friendly encryption tool. Stay tuned for updates and releases.

## Contributing

We welcome contributions from the community. To contribute:

1. Fork the repository.
2. Create a new branch:
`git checkout -b feature/YourFeature`
3. Make your changes and commit them:
`git commit -m "feat: Add your feature"`
4. Push to the branch:
`git push origin feature/YourFeature`
5. Open a pull request.

Please ensure your code adheres to our coding standards and includes appropriate tests.

**Note:** This repository uses conventional commits. Please follow the [conventional commits guidelines](https://www.conventionalcommits.org/en/v1.0.0/) for your commit messages.

## License

This project is licensed under the BSD 2-Clause License. See the [LICENSE](LICENSE) file for details.

## Contact

For any questions or support, please open an issue on GitHub.

0 comments on commit 2bf1447

Please sign in to comment.