Skip to content

Commit 8ade646

Browse files
authored
Update README.md
1 parent 99267a0 commit 8ade646

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# AxonHash
2+
# AxonHash
3+
4+
## Badges
5+
6+
![Tests](https://github.com/rawbytedev/axonhash/actions/workflows/run_test.yml/badge.svg)
7+
![GitHub last commit](https://img.shields.io/github/last-commit/rawbytedev/axonhash)
8+
![Python](https://img.shields.io/badge/python-3.8+-blue.svg)
29

10+
## Quick Start
11+
12+
```bash
13+
python axon_test.py
314
AxonHash is a research and prototyping cryptographic hash function based on ARX (Add-Rotate-Xor) permutation and Merkle tree construction. It is designed for educational, experimental, and benchmarking purposes.
415

516
## Features
@@ -49,11 +60,10 @@ python axon_test.py
4960

5061
## File Structure
5162

52-
- `main.py` : Main AxonHash implementation (class-based)
5363
- `parallel.py` : Standalone and parallelized hash utilities
5464
- `profiler.py` : Profiling and benchmarking script
5565
- `axon_test.py` : Test suite for correctness and performance
56-
- `axon.py` : (If present) Shared core functions
66+
- `axon.py` : Shared core functions
5767

5868
## Security Notice
5969

0 commit comments

Comments
 (0)