From 22a6ba3e48ee92b5cbc0f30a87a4074b35d7e01f Mon Sep 17 00:00:00 2001
From: TheAwiteb <awiteb@hotmail.com>
Date: Sat, 23 Dec 2023 23:28:14 +0300
Subject: [PATCH] Add README.md and CONTRIBUTING.md

---
 CONTRIBUTING.md | 42 ++++++++++++++++++++++++++++++++++
 README.md       | 60 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 102 insertions(+)
 create mode 100644 CONTRIBUTING.md
 create mode 100644 README.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..1c94ee7
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,42 @@
+# Contributing to passrs
+
+Thank you for your interest in contributing to passrs! We welcome contributions from the community to help improve the project.
+
+## Getting Started
+
+To get started with contributing to passrs, please follow these steps:
+
+1. Fork the passrs repository to your own GitHub account.
+2. Clone the forked repository to your local machine.
+3. Create a new branch for your changes: `git checkout -b my-branch-name`.
+4. Make your desired changes to the codebase.
+5. Test your changes to ensure they work as expected.
+6. Commit your changes: `git commit -m "Add my changes"`.
+7. Push your changes to your forked repository: `git push origin my-branch-name`.
+8. Open a pull request from your forked repository to the main passrs repository.
+
+## Code Style
+
+Please follow the existing code style and conventions used in the passrs project. This includes:
+
+- Using Rust's official formatting tool, `rustfmt`, to format your code.
+- Writing clear and concise code with meaningful variable and function names.
+- Adding comments to explain complex logic or algorithms.
+
+## Reporting Issues
+
+If you encounter any issues or bugs while using passrs, please open a new issue on the GitHub repository. When reporting an issue, please provide as much detail as possible, including steps to reproduce the issue and any relevant error messages.
+
+## Feature Requests
+
+If you have a feature request or an idea for improving passrs, we encourage you to open a new issue on the GitHub repository. Please describe the feature or improvement in detail and provide any relevant context or examples.
+
+## Code Review
+
+All contributions to passrs will go through a code review process. This ensures that the code meets the project's standards and maintains its quality. Please be open to feedback and suggestions from the project maintainers during the code review process.
+
+## License
+
+By contributing to passrs, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE) file. This means that you are granting passrs the right to use, modify, and distribute your contributions under the terms of the license. wich is GPL-3.0 License.
+
+Happy contributing!
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2ad2bc4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,60 @@
+# Passrs
+
+Passrs is a local password manager designed to securely store and manage your passwords.
+
+## Installation
+
+To install Passrs, you will need to have the Cargo package manager installed. If you do not have Cargo installed, you can install it by following the instructions [here](https://doc.rust-lang.org/cargo/getting-started/installation.html). Note the Minimum Supported Rust Version (MSRV) for Passrs is `1.70.0`.
+
+1. Clone the Passrs repository:
+    ```bash
+    cargo install --locked --git https://github.com/theawiteb/passrs.git
+    ```
+
+2. Run Passrs:
+    ```bash
+    passrs --help
+    ```
+
+## Uninstallation
+```bash
+cargo uninstall passrs
+```
+
+## Usage
+
+Passrs provides a command-line interface for managing your passwords. The following commands are available:
+
+```
+Local CLI password manager
+
+Usage: passrs [OPTIONS] <COMMAND>
+
+Commands:
+  add    Add new password
+  list   List your password and search
+  clean  Clean the password file
+  help   Print this message or the help of the given subcommand(s)
+
+Options:
+  -p, --passwords-file <PASSWORDS_FILE>
+          The passwords json file, default: $HOME/.local/share/passrs/passwords.json
+  -h, --help
+          Print help
+  -V, --version
+          Print version
+```
+
+<!--
+### Backup
+
+It is important to regularly backup your passwords to prevent data loss. Passrs does not provide an automatic backup feature. To backup your passwords, you can use the export command provided by Passrs. This command allows you to export your encrypted passwords to a json file, which you can then manually backup to a secure location. -->
+
+
+## Contributing
+
+Contributions to Passrs are welcome! If you would like to contribute, please follow the guidelines outlined in the [CONTRIBUTING](CONTRIBUTING.md) file.
+
+## License
+
+Passrs is licensed under the GPL-3.0 License. This means that you are free to use, modify, and distribute the software under the terms of this license. Please refer to the [LICENSE](LICENSE) file for more details.
\ No newline at end of file