Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Harbinger-3 authored Dec 14, 2024
1 parent 45aace3 commit be0b069
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,27 @@ This implementation enhances traditional stream cipher designs, introducing a la

**Browsers**: Compatible with most modern web browsers.

**Legacy versions**: Not yet tested in older versions of some environments.
**Legacy versions**: Not yet tested in some legacy environments, only tested in a simulated environment.

---

# Installation

## Terminal

```bash
sudo apt update && sudo apt upgrade -y
sudo git clone https://github.com/Harbinger-3/Ceilidh20
cd Ceilidh20
```

## HTML

Include the following script in your HTML file:

```bash
<script src="https://raw.githubusercontent.com/Harbinger-3/Ceilidh20/refs/heads/main/src/ceilidh20.min.js"></script>
```

---

Expand Down Expand Up @@ -154,13 +174,14 @@ console.log("Decrypted Data with Custom State:", String.fromCharCode.apply(null,

---

## Example: File Encryption with Node.js (optional)
## Example: File Encryption with Node.js

### Encryption Example:

```javascript
const fs = require('fs');
const crypto = require('crypto');
const Ceilidh20 = require('./src/ceilidh20.js');

const key = crypto.randomBytes(32); // 32 bytes key
const iv = crypto.randomBytes(32); // 32 bytes IV
Expand All @@ -181,6 +202,7 @@ fs.writeFileSync("sample.png.encrypted", encryptedOutput);
```javascript
const fs = require('fs');
const crypto = require('crypto');
const Ceilidh20 = require('./src/ceilidh20.js');

const key = Buffer.from([/* your 32-bytes key here */]);
const iv = Buffer.from([/* your 32-bytes iv here */]);
Expand Down

0 comments on commit be0b069

Please sign in to comment.