From 94bc26c5eab119aa66c90491fba41bfc9f4907a1 Mon Sep 17 00:00:00 2001 From: objnull Date: Fri, 9 Aug 2024 23:27:34 -0400 Subject: [PATCH] Created ReadMe --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0b6d751..ae412a9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ # FlippyPass -A Password Manager for the Flipper-Zero \ No newline at end of file +A Password Manager for the Flipper-Zero + +* [About this Project](#about-this-project) +* [Installing](#installing) +* [Building](#building) + +## About this Project + +This is a very simple Password Manager build in *Rust* for the Flipper Zero. The goal of this project is to allow anyone to use the flipper zero as their to go password manager! + +This project was designed with simplicity and security in mind. All of your passwords **will** be safely encrypted and stored on your Flipper-Zero device. + +## Installing + +In order to Install this application, all you'll need to do is go to the [Releases Tab](https://git.objnull.net/objnull/FlippyPass/releases) on my Gitea instance and download the latest **.FAP** file. Place the file inside of: */SD Card/apps/tools*. + +Launch the application, go through some basic setup options, and you're set for using the password manager! + +## Building + +I went ahead and made this project easy to build and get started on contributing to. Since the project was written in *Rust*, the code will be more cohearent all-around. + +To build the project, make sure you have Docker installed. Run `./scripts/docker.sh` to build the *flipper-dev* Docker image. Next, just run `./scripts/build.sh` to have Rust compile an executable to the *build/* directory! \ No newline at end of file