readme

Author: dcodesdev

Cargo.toml

@@ -2,6 +2,9 @@
 name = "clipcat"
 version = "0.1.0"
 edition = "2021"
+description = "A command line tool for copying the contents to clipboard of multiple files in one go."
+repository = "https://github.com/dcodesdev/clipcat"
+license = "MIT"
 
 [dependencies]
 anyhow = "1.0.86"

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 dcodes
+
+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

@@ -0,0 +1,45 @@
+# ClipCat
+
+A fast and simple CLI tool to copy multiple files with a single command.
+
+## Why this tool?
+
+The reason for this tool is to make it easier to copy a large amount of your source code or text files to the clipboard. This can be useful when you want to give your LLM some context on what you are asking about.
+
+## Usage
+
+Give it a directory and it will copy all the contents of the files in that directory and subdirectories that have a valid UTF-8 encoding to the clipboard.
+
+```bash
+clipcat path/to/directory
+```
+
+## Installation
+
+You can either download a pre-built binary or install the tool using Cargo.
+
+### Install using Cargo
+
+If you have Rust installed, you can build the tool from source using Cargo.
+
+```bash
+cargo install clipcat
+```
+
+### Pre-built binaries
+
+You can visit the [releases page](https://github.com/dcodesdev/clipcat/releases) to download the latest binary for your platform.
+
+## Building from source
+
+If you want to build the tool from source, you can do so using Cargo.
+
+```bash
+git clone https://github.com/dcodesdev/clipcat
+cd clipcat
+cargo build --release
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.