Skip to content

Commit 98e074c

Browse files
authored
Update README.md
1 parent fc9d5bc commit 98e074c

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,30 +11,30 @@ CLIK provides you with a command line interface that allows you to store your AP
1111
You are provided with an option to either store this key locally in a file, or making a note of it to store it anyway you like.
1212
The encrypted JSON file can safely be uploaded to VCS repositories, meaning access will only be granted to those who have been given the JSON decryption key by you.
1313
You can use the CLIK to also add, remove or modify keys, as and when required.
14-
## Built With:
14+
## Built With
1515
| Software | Version |
1616
|----------|---------|
1717
| Python 3 | 3.7.1 |
1818
| Visual Studio Code| 1.50.1|
1919

20-
## Tested With:
20+
## Tested With
2121
| Operating System | Version(s) |
2222
|----------|-------------|
2323
| Microsoft Windows | Windows 10 |
2424
| Apple macOS | 10.15(Catalina), Beta 11.0(Big Sur) |
2525

26-
## Installation:
26+
## Installation
2727
You can either clone this repository or install it via pip
2828
```python
2929
pip install clik
3030
```
3131

32-
## Usage:
32+
## Usage
3333
Once you install CLIK, a short and concise documentation can be found br running the following command on your console:
3434
```python
3535
clik
3636
```
37-
## Initialising the JSON File:
37+
## Initialising the JSON File
3838
To create a new file to store keys type the following command in your console:
3939
```python
4040
clik init
@@ -43,32 +43,32 @@ Now, you can specify all the keys you want to add in a step by step fashion.
4343
CLIK will automatically encrypt the file for you and generate your encryption key.
4444
Now you can either store the key locally or write it down for safekeeping.
4545
So now, your JSON file containing all your keys is ready for upload on your repository.
46-
## Adding/Subtracting Keys:
46+
## Adding/Subtracting Keys
4747
To add new keys to an existing JSON file, type the following command in your console:
4848
<br>
49-
### For Adding Keys:
49+
### For Adding Keys
5050
```python
5151
clik FILENAME add
5252
```
5353

54-
### For Subtracting Keys:
54+
### For Subtracting Keys
5555
```python
5656
clik FILENAME subtract
5757
```
58-
## For Modifying Keys:
58+
## For Modifying Keys
5959
To modify any key in an existing JSON file, type the following command in your console:
6060
```python
6161
clik FILENAME modify
6262
```
63-
## For Encrypting the Keys File:
63+
## For Encrypting the Keys File
6464
To encrypt the JSON file, type the following command in your console:
6565
```python
6666
clik FILENAME enc
6767
```
6868
This will ask for any existing Keys to encrypt the JSON file with. If you have an existing Key,
6969
continue. Else, you can specify/create a new key for this new encryption.
7070

71-
## For Decrypting the Keys File:
71+
## For Decrypting the Keys File
7272
To decrypt the JSON file, type the following command in your console:
7373
```python
7474
clik FILENAME dec
@@ -78,7 +78,7 @@ continue normally. Else, provide a path for the Key to be used for decryption.
7878

7979
> Note: For any kind of operation on an encrypted JSON file, you need to decrypt it first.
8080
81-
## Help:
81+
## Help
8282
To check the syntax for any of the commands or their function, type the following command in your console:
8383
```python
8484
clik --help

0 commit comments

Comments
 (0)