Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sweeistaken authored Dec 24, 2024
1 parent 780a7b6 commit 006d335
Showing 1 changed file with 30 additions and 8 deletions.
38 changes: 30 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,39 @@
A basic and fun cipher module for everyone. it converts regular text into symbols on a keyboard, kind of like a cipher. This is only for fun, using this module for cybersecurity is NOT ADVISED

Install:
`pip3 install sweecrypt`
```
pip3 install sweecrypt
```

Import:
`import sweecrypt`
```python
>>> import sweecrypt
```

Encrypt:
`sweecrypt.encrypt("hello, world!")`
Output:
`!?~~(:,}(>~/a`
```python
>>> sweecrypt.encrypt("hello, world!")
!?~~(:,}(>~/a
```

Decrypt:
`sweecrypt.decrypt("!?~~(:,}(>~/a")`
<br>Output:
`hello, world!`
```python
>>> sweecrypt.decrypt("!?~~(:,}(>~/a")
hello, world!
```

With newer versions of sweecrypt (>= 1.1.0), you can shift the encryption database:

```python
>>> sweecrypt.encrypt("hello, world", 3)
'\\!((>ba_>](#'
>>> sweecrypt.decrypt("\\!((>ba_>](#", 3)
'hello, world'
```

So it will output a nonsense string if shifted incorrectly.

```python
>>> sweecrypt.decrypt("\\!((>ba_>](#")
'khoor?!zruog'
```

0 comments on commit 006d335

Please sign in to comment.