TemplateDocs
Project README
The README skeleton that answers a newcomer's four questions in order: what is this, how do I run it, how do I use it, how do I change it.
Last updated
Fill in the blanks
Assembled in your browser — nothing you type is stored or sent anywhere.
Your document
# log-sifter
A command-line tool that filters and summarizes JSON log files without loading them fully into memory.
## Getting started
```bash
npm install
npm run dev
```
## Usage
Point it at a log file and a filter expression:
```bash
log-sifter app.log --where level=error --last 24h
```
## Project structure
- `src/` — CLI entry point and filter engine
- `test/` — unit tests, one file per module
## Contributing
Issues and pull requests are welcome. Before opening a PR, please run the test suite and keep changes focused — one concern per PR.
## License
MIT
How to use it well
- →The one-liner earns the reader's next 30 seconds — write it for someone deciding whether this repo is even relevant to them.
- →Getting-started commands must be copy-paste runnable on a clean machine; every assumption you skip becomes someone's first issue.
- →Cut any section you'd fill with boilerplate — an honest short README beats a template fully populated with nothing.