diff --git a/README.md b/README.md index e69de29..1b4281b 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,53 @@ +Here's a clean and concise `README.md` for your **`solvertools`** Python library, focusing on its purpose and how to use it without diving into the implementation details: + +--- + +# solvertools + +**solvertools** is a lightweight Python library providing utility functions to help build and run Capture The Flag (CTF) challenge solvers. It’s especially useful when integrating with [`ctfcli`](https://github.com/CTFd/ctfcli) for setting up automated healthchecks. + +--- + +## πŸ”§ Features + +- Simplifies the setup for connecting to local or remote challenge instances. +- Provides easy flag extraction and result reporting. +- Designed to streamline CTF development workflows. + +--- + +## πŸš€ Installation + +```bash +pip install pwntools +pip install solvertools +``` + +## πŸ’‘ Designed for ctfcli + +This library helps you quickly write challenge solvers that integrate cleanly with `ctfcli`, making it easy to set up automated healthchecks for your challenges. + +## πŸ›  Requirements + +- Python 3.6+ +- [pwntools](https://docs.pwntools.com/) + +--- + +## πŸ§ͺ Example Healthcheck Solver + +```python +#!/usr/bin/env python3 +from solvertools import connect_tcp, extract_flag + +conn = connect_tcp("challenge.py") +conn.sendline(b"some input") +output = conn.recvall().decode() +extract_flag(output, r"flag\{.*?\}") +``` + +--- + +## πŸ“œ License + +MIT License. Feel free to use and adapt!