aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md49
1 files changed, 38 insertions, 11 deletions
diff --git a/README.md b/README.md
index e197e393..e70a3dbd 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,43 @@
-# Gpg Frontend
+# GpgFrontend
-GpgFrontend is a modern, easy-to-use, compact, cross-platform, and installation-free gpg front-end tool. By using
-GpgFrontend, you can quickly **encrypt and decrypt text or files**. Or at the same time as the above operations, you can
-add
-**your own signature** to let others know that this document or this paragraph of text was issued by you.
+![Language](https://img.shields.io/badge/language-C%2B%2B-green)
+![License](https://img.shields.io/badge/License-GPL--3.0-orange)
+![CodeSize](https://img.shields.io/github/languages/code-size/saturneric/GpgFrontend)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/d1750e052a85430a8f1f84e58a0fceda)](https://www.codacy.com/gh/saturneric/GpgFrontend/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saturneric/GpgFrontend&utm_campaign=Badge_Grade)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/saturneric/gpgfrontend)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsaturneric%2FGpgFrontend.svg?type=small)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsaturneric%2FGpgFrontend?ref=badge_small)
+
+GpgFrontend is a Modern, Easy-to-Use, Compact, Cross-Platform, and Installation-Free OpenPGP Frontend Tool.
+
+By using GpgFrontend, you can quickly **encrypt and decrypt text or files**. Or at the same time as the above
+operations, you can add **your own signature** to let others know that this document or this paragraph of text was
+issued by you.
Furthermore, it visualizes most of the common operations of gpg commands. It aims to allow ordinary users to quickly use
-gpg and make professional users more convenient. GpgFrontend supports some new features of OpenPGP.
+gpg and make professional users more convenient. GpgFrontend supports new features of OpenPGP.
![Main ScreenShot](https://github.com/saturneric/Blob/blob/master/screenshots/main.png?raw=true)
+## Table of Contents
+
+- [Features](#features)
+- [Usage](#usage)
+- [Purpose](#purpose)
+- [Build](#build)
+- [Contract](#contract)
+ - [Contributing](#contributing)
+ - [Maintainers](#maintainers)
+- [Licenses](#LICENSES)
+
## Features
- Open source, free, no need to install.
-- Can run on Windows, Linux and macOS.
+- Can run on **Windows, Linux and macOS**.
- Just double-click, and then you can use it freely.
- Before use, you only need to install gnupg. A tiny tool of a few MB.
- Supports multiple languages. Don’t forget to help me translate this software.
-## How to Use it
+## Usage
0. Install gnupg. To check if it is installed, you can enter gpg on the command line.
- For Windows User, Click [this link](https://gnupg.org/ftp/gcrypt/binary/gnupg-w32-2.3.1_20210420.exe) to download
@@ -41,21 +60,29 @@ request.
The GpgFrontend project is as open source, and it also insists on using open source codes and libraries.
-## How to Build it
+## Build
The tutorial for building the software will be released shortly.
## Contract
-If you have any questions, please open an issue. If you want to contact me individually, you can email [email protected].
+If you want to contact me individually, you can email [[email protected]](mailto:[email protected]).
+### Contributing
+
+Feel free to dive in! [Open an issue](https://github.com/saturneric/GpgFrontend/issues/new) or submit PRs.
+
+### Maintainers
+
+[@Saturneric](https://github.com/saturneric).
## LOGO
+
![logo](https://github.com/saturneric/Blob/blob/master/logos/gpgfrontend-logo.jpg?raw=true)
## LICENSES
-GpgFrontend itself is licensed under the GPLv3 (see COPYING).
+GpgFrontend itself is licensed under the [GPLv3](COPYING).
There are some libraries, and the gpg-binary included in the zip-file / a static gpg-build which (may) have different
licenses, for more information check their homepages. You can also obtain the sources from there.