att

Author: mateusmoutinho

LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org>

README.md

@@ -1,31 +1,61 @@
 
-a system  to join docs into a single markdown file
+# Doc-Join
+
+A professional documentation aggregation tool that combines multiple documents into a single markdown file.
+
+## Overview
+
+Doc-Join streamlines the process of consolidating documentation by automatically merging multiple markdown files and directories into a cohesive single document. This tool is particularly useful for creating comprehensive documentation packages, reports, or consolidated references.
+
+## Prerequisites
+
+Doc-Join requires VibeScript as a runtime dependency. Please ensure you have `gcc` or `clang` installed on your system before proceeding.
+
 ## Installation
-- step 1 : Install vibescript 
-Install [vibescript](https://github.com/OUIsolutions/VibeScript) if you don't have it yet:
 
-### Linux 
-Run the following command to install VibeScript on Linux:
+### Step 1: Install VibeScript
+
+Choose the appropriate installation method for your operating system:
 
+#### Option A: Pre-compiled Binary (Linux only)
 ```bash
 curl -L https://github.com/OUIsolutions/VibeScript/releases/download/0.32.0/vibescript.out -o vibescript.out && chmod +x vibescript.out && sudo mv vibescript.out /usr/local/bin/vibescript
 ```
 
-### Linux and macOS
-You need to have `gcc` or `clang` installed:
-
+#### Option B: Compile from Source (Linux and macOS)
 ```bash
 curl -L https://github.com/OUIsolutions/VibeScript/releases/download/0.35.0/amalgamation.c -o vibescript.c && gcc vibescript.c -o vibescript.out && sudo mv vibescript.out /usr/local/bin/vibescript
 ```
-- step 2 : Install doc_join
+
+### Step 2: Install Doc-Join
 ```bash
-vibescript add_script --file  https://github.com/Igreja-ChimpStack/Doc-Join/releases/download/0.1.0/doc_join.lua doc_join
+vibescript add_script --file https://github.com/Igreja-ChimpStack/Doc-Join/releases/download/0.1.0/doc_join.lua doc_join
 ```
 
+## Usage
 
+### Basic Syntax
+```bash
+doc_join --entries <input_files_or_directories> --output <output_file>
+```
 
-## Usage
+### Example
 ```bash
- doc_join --entries docs README.md --output teste.md 
+doc_join --entries docs README.md --output consolidated_documentation.md
 ```
 
+This command will process all files in the `docs` directory along with the `README.md` file, combining them into `consolidated_documentation.md`.
+
+## Parameters
+
+- `--entries`: Specify input files and/or directories to be processed
+- `--output`: Define the output filename for the consolidated markdown document
+
+## License
+
+This project is released into the public domain under the [Unlicense](LICENSE). You are free to use, modify, and distribute this software without any restrictions.
+
+## Contributing
+
+For contributions, bug reports, or feature requests, please visit the [project repository](https://github.com/Igreja-ChimpStack/Doc-Join).
+