diff --git a/README.md b/README.md index a7c456b..433d8d7 100644 --- a/README.md +++ b/README.md @@ -30,35 +30,6 @@ Before you begin, ensure you have the following installed: - [Node.js](https://nodejs.org/) (14.0.0 or later) - A modern web browser that supports WebAssembly -## Project Structure - -``` -webassembly/ -├── src/ -│ ├── api/ # Public API modules -│ │ ├── keypair.rs # Public keypair API -│ │ ├── mod.rs # API module exports -│ │ └── symmetric.rs # Public symmetric encryption API -│ ├── core/ # Internal implementation modules -│ │ ├── error.rs # Error types and conversions -│ │ ├── keypair.rs # Core keypair implementation -│ │ ├── mod.rs # Core module exports -│ │ └── symmetric.rs # Core symmetric encryption implementation -│ ├── tests/ # Test modules -│ │ ├── keypair_tests.rs # Tests for keypair functionality -│ │ ├── mod.rs # Test module exports -│ │ └── symmetric_tests.rs # Tests for symmetric encryption -│ └── lib.rs # Main entry point, exports WASM functions -├── www/ -│ ├── index.html # Example HTML page -│ ├── server.js # Simple HTTP server for testing -│ └── js/ -│ └── index.js # JavaScript code to load and use the WebAssembly module -├── Cargo.toml # Rust package configuration -├── start.sh # Script to build and run the example -└── README.md # This file -``` - ## Running the Example The easiest way to run the example is to use the provided start script: