License and readme.

Author: script3r

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 Isaac Elbaz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -13,7 +13,7 @@
 - **High Performance**: Scans large codebases quickly by leveraging parallelism.
 - **Language-Aware**: Uses Tree-sitter parsers to understand code structure, reducing false positives.
 - **Extensible Patterns**: Define custom patterns in a simple TOML file to find new libraries and algorithms.
-- **Multiple Language Support**: Scans C, C++, Java, Python, Go, Swift, Objective-C, and Rust.
+- **Multiple Language Support**: Scans C, C++, Java, Python, Go, Swift, PHP, Objective-C, and Rust.
 - **Flexible Output**: Outputs findings as JSONL to stdout or a file for easy integration with other tools.
 - **Cross-Platform**: Built in Rust, runs on macOS, Linux, and Windows.
 
@@ -103,3 +103,27 @@ The output is a stream of JSONL objects, where each object represents a single f
 ## Patterns
 
 `cipherscope` relies on a `patterns.toml` file to define what to look for. This file contains definitions for:
+- **Libraries**: Anchors used to detect specific crypto libraries, like import statements.
+- **Algorithms**: Symbols and function calls associated with specific algorithms (e.g., "AES-GCM") within a library.
+
+You can customize this file to add support for new libraries or improve detection for existing ones.
+
+## Development
+
+### Building from Source
+1. Clone the repository.
+2. Build the project using Cargo:
+   ```bash
+   cargo build --release
+   ```
+   The binary will be located at `./target/release/cipherscope`.
+
+### Running Tests
+To run the integration test suite:
+```bash
+cargo test
+```
+
+## License
+
+This project is licensed under the MIT License. See the `LICENSE` file for details.