Skip to content

Commit

Permalink
Updated readthedoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Justaus3r committed Apr 12, 2021
1 parent d0e5b99 commit 00c36d2
Showing 1 changed file with 92 additions and 0 deletions.
92 changes: 92 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
Readme.md 👋
~~~~~~~~~~~

Anfu
----

|GPLv3 License| |Contribution| |language| |Active| |GitHub commits
since| |Issues| |GitHub Release| |Code of Conduct| |Read the Docs| |Open
Source|

A python program to Encrypt Files and Directories using Symmetric
encryption(fernet) Encryption.it has a simple Textual user
interface(TUI).its available for both Linux and Windows.

Download
~~~~~~~~

+---------------+--------------------------------------------------------------------------------------------------+
| Date: | Comment: |
+===============+==================================================================================================+
| **Windows** | `Windows <https://drive.google.com/uc?export=download&id=19sQsUEwv6K-4VQEy7rvuG_1sScKD8geh>`__ |
+---------------+--------------------------------------------------------------------------------------------------+
| **Linux** | `Linux <https://drive.google.com/uc?export=download&id=1vBNCZDR8a4H8QDAvZ8ArwfttGWceo5x_>`__ |
+---------------+--------------------------------------------------------------------------------------------------+

Screenshot:
~~~~~~~~~~~

`Screenshot <https://drive.google.com/uc?export=download&id=19sQsUEwv6K-4VQEy7rvuG_1sScKD8geh>`__

Usage:
------

Windows:
^^^^^^^^

Just install the executable and start using it

Linux:
''''''

- Download the zip and extract it
- Change the permission of setup file to executable(i.e
``chmod +x setup.sh``)
- Execute the script i.e:\ ``./setup.sh``
- Type ``Anfu`` in terminal and start using it.cheers! ### Key Features
- A simple and attractive TUI(Textual user interface).
- Portable ,no need for installation.install anywhere anytime
- Symmetric encryption.Files are encrypted with high level encryption

TODO List:
~~~~~~~~~~

- Add mouse support
- Encrypt Files with password

🔴Note:
~~~~~~

Please keep the encryption key safe,if anyone gets it you data might get
compromised.if you don't want to keep the key file then open it and copy
the key and keep that key somewhere safe.

Conttribution:
~~~~~~~~~~~~~~

All Contributions are Welcomed..Fork the repo and pull
requests.Suggestions at x-neron@pm.me

License:
~~~~~~~~

Distributed Under GPLV3

.. |GPLv3 License| image:: https://img.shields.io/badge/License-GPL%20v3-yellow.svg
:target: https://opensource.org/licenses/
.. |Contribution| image:: https://img.shields.io/badge/Contributions-Welcome-<brightgreen>
.. |language| image:: https://badgen.net/badge/Language/Python/cyan
.. |Active| image:: http://img.shields.io/badge/Status-Active-green.svg
:target: https://github.com/Justaus3r
.. |GitHub commits since| image:: https://img.shields.io/github/commits-since/Justaus3r/Anfu/0.1
:target:
.. |Issues| image:: https://img.shields.io/github/issues-raw/Justaus3r/Penta?maxAge=25000
:target: https://github.com/Justaus3r/Penta/issues
.. |GitHub Release| image:: https://img.shields.io/github/release/Justaus3r/Anfu?style=flat
:target:
.. |Code of Conduct| image:: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat
:target: https://github.com/Justaus3r/Penta/blob/main/docs/CODE_OF_CONDUCT.md
.. |Read the Docs| image:: https://readthedocs.org/projects/penta/badge/?version=latest
:target: https://anfu.readthedocs.io/en/latest/?badge=latest
.. |Open Source| image:: https://badges.frapsoft.com/os/v1/open-source.svg?v=103
:target: https://opensource.org/

0 comments on commit 00c36d2

Please sign in to comment.