Skip to content

Folder encryption and decryption tool built with Scala

License

Notifications You must be signed in to change notification settings

Spyder01/Charlotte

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Issues MIT License LinkedIn


Logo

Charlotte

An awesome Scala based tool to encrypt your files.
Explore the docs »

· Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Charlotte is an easy-to-use command-line tool to encrypt your files.

Why Use:

  • It's easy to use and minimalistic hence you are not crowded by myriad of unwanted features.
  • It's safe and secure.

(back to top)

### Built With
  • Scala

(back to top)

Getting Started

Prerequisites

  • Make sure git is installed in your system.
  • Make sure you have jdk installed.
  • Make sure you have Scala and sbt.

Installation

Below is how you can install repository on your system.

  1. Clone the repo
    git clone https://github.com/SuhanBangera/Charlotte

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Add Basic Functionality.
  • Add support for encrypting folders.
  • Add support for encrypting individual files.
  • Resolve the access issues for internal directories.
  • Implement more secure encryption method.
  • Utilize multithreading for better performance.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Suhan Bangera - @Suhan

Project Link: https://github.com/SuhanBangera/Charlotte

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)

Releases

No releases published

Packages

No packages published

Languages