Skip to content

Commit

Permalink
Add README TOC and [build]
Browse files Browse the repository at this point in the history
  • Loading branch information
HR committed Jul 2, 2019
1 parent 43b023b commit 26be9b0
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 2 deletions.
3 changes: 2 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ after_success:
# Cleanup
- git reset --hard HEAD
# Remove untracked and ignored files
- git clean -dfX
- git clean -dfXn && git clean -dfX
- chmod +x ./script/*.sh
# Check if build triggered ([build] in commit message)
- lgcm=$(git log -1 --pretty=%B | xargs echo);
if [[ $lgcm == *"[build]"* ]]; then
Expand Down
49 changes: 48 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,49 @@ So please check it out as well!

Link to this README: https://git.io/Crypter.info


---
# Contents
<!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->

- [Installation](#installation)
- [Screens](#screens)
- [Crypto](#crypto)
- [Encryption process](#encryption-process)
- [Decryption process](#decryption-process)
- [Public credentials](#public-credentials)
- [CRYPTO file](#crypto-file)
- [Format](#format)
- [Reusing the same MasterPass](#reusing-the-same-masterpass)
- [Achieving portability and same MasterPass reuse](#achieving-portability-and-same-masterpass-reuse)
- [Security](#security)
- [Security-first practice](#security-first-practice)
- [MasterPass](#masterpass)
- [MasterPassKey](#masterpasskey)
- [FAQs](#faqs)
- [How do I encrypt a file or folder?](#how-do-i-encrypt-a-file-or-folder)
- [How do I decrypt a CRYPTO file?](#how-do-i-decrypt-a-crypto-file)
- [How do I encrypt multiple files?](#how-do-i-encrypt-multiple-files)
- [Why am I getting the `Corrupted Crypter file or trying to decrypt on a different](#why-am-i-getting-the-corrupted-crypter-file-or-trying-to-decrypt-on-a-different)
- [machine.` error?](#machine-error)
- [Why can't I decrypt a CRYPTO file on a different machine with the same MasterPass?](#why-cant-i-decrypt-a-crypto-file-on-a-different-machine-with-the-same-masterpass)
- [Why can't I decrypt a CRYPTO file with the same MasterPass?](#why-cant-i-decrypt-a-crypto-file-with-the-same-masterpass)
- [Where are my encrypted/decrypted files/folders placed?](#where-are-my-encrypteddecrypted-filesfolders-placed)
- [How can I access Crypter's preferences?](#how-can-i-access-crypters-preferences)
- [How can I reset my MasterPass?](#how-can-i-reset-my-masterpass)
- [What is a valid MasterPass?](#what-is-a-valid-masterpass)
- [What are MasterPass credentials?](#what-are-masterpass-credentials)
- [How can I export my MasterPass credentials?](#how-can-i-export-my-masterpass-credentials)
- [How can I import my MasterPass credentials?](#how-can-i-import-my-masterpass-credentials)
- [Development](#development)
- [Configurations](#configurations)
- [Install (dependencies)](#install-dependencies)
- [Run](#run)
- [Test](#test)
- [Build](#build)
- [License](#license)

<!-- /TOC -->
---
## Installation
All prebuilt binaries for all major platforms are available under
[releases](https://github.com/HR/Crypter/releases/latest).
Expand Down Expand Up @@ -287,6 +329,11 @@ some information about the file and its original encryption in a new window. By
default, the decrypted file has the same name as the name of the original file
(i.e. the encrypted file name without the `.crypto` at the end).

### How do I encrypt multiple files?
Crypter can encrypt an entire folder so you can put them in a folder or,
alternatively, compress them into an archive (like a `.zip`) and then just pass
it to Crypter ;)

### Why am I getting the `Corrupted Crypter file or trying to decrypt on a different
### machine.` error?
This error means that either your Crypter file (i.e. the `data` file) is
Expand Down

0 comments on commit 26be9b0

Please sign in to comment.