Skip to content

Commit 01829af

Browse files
authored
Update README.md
1 parent 837a5e8 commit 01829af

File tree

1 file changed

+10
-32
lines changed

1 file changed

+10
-32
lines changed

README.md

Lines changed: 10 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ pip install fastCrypter[native]
5353
### Basic Usage
5454

5555
```python
56-
import fastCrypterer
56+
import fastCrypter
5757

5858
# Get the recommended compressor (automatically uses native acceleration if available)
59-
compressor = fastCrypterer.get_recommended_compressor(password="your_secure_password")
59+
compressor = fastCrypter.get_recommended_compressor(password="your_secure_password")
6060

6161
# Compress and encrypt data
6262
data = b"Your sensitive data here"
@@ -70,7 +70,7 @@ assert data == decrypted
7070
### Custom Encoding Example
7171

7272
```python
73-
from fastCrypterer import CustomEncoder
73+
from fastCrypter import CustomEncoder
7474

7575
# Create custom encoder with your character set
7676
encoder = CustomEncoder(charset="abcdef98Xvbvii")
@@ -88,7 +88,7 @@ assert original == decoded
8888
### File Encryption
8989

9090
```python
91-
from fastCrypterer import FileEncryptor
91+
from fastCrypter import FileEncryptor
9292

9393
# Initialize file encryptor
9494
encryptor = FileEncryptor(password="your_password")
@@ -100,27 +100,6 @@ encryptor.encrypt_file("document.pdf", "document.pdf.encrypted")
100100
encryptor.decrypt_file("document.pdf.encrypted", "document_restored.pdf")
101101
```
102102

103-
## 🏗️ Architecture
104-
105-
fastCrypter is built with a modular architecture:
106-
107-
```
108-
fastCrypter/
109-
├── core/ # Core functionality
110-
│ ├── compressor.py # Compression algorithms
111-
│ ├── encryptor.py # Encryption algorithms
112-
│ ├── key_manager.py # Key derivation and management
113-
│ └── custom_encoder.py # Custom encoding schemes
114-
├── algorithms/ # Algorithm implementations
115-
│ ├── compression/ # Compression algorithms
116-
│ └── encryption/ # Encryption algorithms
117-
├── native/ # Native C/C++ libraries
118-
│ ├── libs/ # Compiled libraries (.so/.dll/.dylib)
119-
│ └── native_loader.py # Python bindings
120-
├── utils/ # Utility functions
121-
└── exceptions.py # Custom exceptions
122-
```
123-
124103
## 🔧 Native Compilation
125104

126105
fastCrypter includes C/C++ libraries for performance-critical operations:
@@ -178,7 +157,7 @@ Example results on modern hardware:
178157
### Enhanced Compressor
179158

180159
```python
181-
from fastCrypterer import EnhancedCompressor
160+
from fastCrypter import EnhancedCompressor
182161

183162
# Create enhanced compressor with native acceleration
184163
compressor = EnhancedCompressor(
@@ -195,7 +174,7 @@ if compressor.is_native_available():
195174
### Custom Algorithms
196175

197176
```python
198-
from fastCrypterer.core import Compressor, CompressionAlgorithmType
177+
from fastCrypter.core import Compressor, CompressionAlgorithmType
199178

200179
# Use specific compression algorithm
201180
compressor = Compressor(
@@ -207,7 +186,7 @@ compressor = Compressor(
207186
### Secure Key Management
208187

209188
```python
210-
from fastCrypterer import KeyManager
189+
from fastCrypter import KeyManager
211190

212191
# Generate secure keys
213192
key_manager = KeyManager()
@@ -270,10 +249,9 @@ mypy fastCrypter/
270249

271250
## 📚 Documentation
272251

273-
- **API Reference**: [docs.fastCrypter.dev](https://docs.fastCrypter.dev)
274-
- **Examples**: See `examples/` directory
252+
- **API Reference**: [ [Document](https://fastcrypter.readthedocs.io) ]
253+
- **Examples**: See `examples/` directory [Examples](https://github.com/Pymmdrza/fastCrypter/tree/main/examples)
275254
- **Performance Guide**: [Performance Optimization](docs/performance.md)
276-
- **Security Guide**: [Security Best Practices](docs/security.md)
277255

278256
## 🤝 Contributing
279257

@@ -307,4 +285,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
307285

308286
---
309287

310-
**fastCrypter** - Making encryption fast, secure, and accessible! 🚀🔐
288+
**`fastCrypter`** - Making encryption fast, secure, and accessible! 🚀🔐

0 commit comments

Comments
 (0)