feat: Add README.md

README.md

@@ -0,0 +1,80 @@
+# Rollup
+
+Rollup is a powerful CLI tool designed to aggregate and process files based on specified criteria. It's particularly useful for developers and system administrators who need to collect and summarize information from multiple files across a project or system.
+
+## Features
+
+- File type filtering
+- Ignore patterns for excluding files
+- Support for code-generated file detection
+- Optional web scraping functionality
+- Verbose logging option for detailed output
+
+## Installation
+
+To install Rollup, make sure you have Go installed on your system, then run:
+
+```bash
+go get github.com/tnypxl/rollup
+```
+
+## Usage
+
+Basic usage:
+
+```bash
+rollup [flags]
+```
+
+### Flags
+
+- `--file-types`: Comma-separated list of file types to include (default: all files)
+- `--ignore`: Comma-separated list of patterns to ignore
+- `--code-generated`: Comma-separated list of patterns for code-generated files
+- `--verbose, -v`: Enable verbose logging
+- `--config`: Path to the configuration file (default: rollup.yml)
+
+## Configuration
+
+Rollup can be configured using a YAML file. By default, it looks for `rollup.yml` in the current directory. You can specify a different configuration file using the `--config` flag.
+
+Example `rollup.yml`:
+
+```yaml
+file_types:
+  - .go
+  - .md
+ignore:
+  - vendor/**
+  - **/test/**
+code_generated:
+  - **/generated/**
+scrape:
+  url: https://example.com
+  css_locator: .content
+```
+
+## Examples
+
+1. Basic usage with default configuration:
+   ```bash
+   rollup
+   ```
+
+2. Use specific file types and enable verbose logging:
+   ```bash
+   rollup --file-types=.go,.js,.py --verbose
+   ```
+
+3. Use a custom configuration file:
+   ```bash
+   rollup --config=my-config.yml
+   ```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+[MIT License](LICENSE)