Skip to content

Commit 9dc86b2

Browse files
committed
Add README.md
1 parent f323570 commit 9dc86b2

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# IPCrypt Website
2+
3+
This repository contains the source code for the IPCrypt specification website, deployed at [ipcrypt-std.github.io](https://ipcrypt-std.github.io).
4+
5+
## About IPCrypt
6+
7+
IPCrypt is a lightweight encryption technique for IPv4 and IPv6 addresses that preserves address format while providing cryptographic obfuscation. It's designed for applications that need to anonymize IP addresses while maintaining their utility for analysis.
8+
9+
## Repository Structure
10+
11+
- `/www` - Jekyll-based static site source
12+
- `/_implementations` - Code examples in various languages
13+
- `/pages` - Main content pages (specification, implementations, etc.)
14+
- `/assets` - CSS, JavaScript, and images
15+
16+
## Local Development
17+
18+
```bash
19+
cd www
20+
./setup.sh # Initial setup
21+
bundle exec jekyll serve
22+
```
23+
24+
The site will be available at `http://localhost:4000/`
25+
26+
## Deployment
27+
28+
The site automatically deploys to GitHub Pages when changes are pushed to the `main` branch.
29+
30+
## Contributing
31+
32+
Contributions are welcome! Please feel free to submit pull requests with:
33+
- New language implementations
34+
- Documentation improvements
35+
- Bug fixes

0 commit comments

Comments
 (0)