docs: add README + License

Author: Matéo Fernandez

Cargo.toml

@@ -2,6 +2,10 @@
 name = "excel_gen"
 version = "0.1.0"
 edition = "2021"
+authors = [
+  "Matéo Fernandez <[email protected]>",
+  "Gilles Gauthier <[email protected]>",
+]
 
 [dependencies]
 apache-avro = "0.17"

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024-present, Spiriit
+
+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,103 @@
+# excel_gen
+
+A CLI tool, written in Rust :crab:, to generate Excel files from an HTML or Avro file (if needed, we can add other input types).
+
+It is used by our PHP library [SpiriitLabs/php-excel-rust](https://github.com/SpiriitLabs/php-excel-rust) to generate Excel files.
+
+Why did we do it ?  
+Because PHP was too slow to generate our excel files, and because it's fun. :D
+
+## How to use
+
+```md
+Usage: excel_gen [OPTIONS] --output <OUTPUT> <COMMAND>
+
+Commands:
+  avro  Input from Avro
+  html  Input from HTML
+  help  Print this message or the help of the given subcommand(s)
+
+Options:
+  -o, --output <OUTPUT>  Path to excel file output
+  -v, --verbose...       Increase logging verbosity
+  -q, --quiet...         Decrease logging verbosity
+  -h, --help             Print help
+  -V, --version          Print version
+```
+
+### Use with Avro
+
+```bash
+excel_gen --output ./output.xlsx avro --file ./input.avro
+```
+
+> [!NOTE]
+> You can find the Avro schema here: [`./schema.json`](./schema.json)
+
+### Use with HTML
+
+```bash
+excel_gen --output ./output.xlsx html --file ./input.html
+```
+
+> [!NOTE]
+> <details>
+>  <summary>HTML example</summary>
+>
+> ```html
+> <table>
+>   <thead>
+>     <tr>
+>       <th>Name</th>
+>       <th>Age</th>
+>       <th>City</th>
+>     </tr>
+>   </thead>
+>   <tbody>
+>     <tr>
+>       <td>
+>         John Doe
+>       </td>
+>       <td>30</td>
+>       <td>New York</td>
+>     </tr>
+>     <tr>
+>       <td>Jane Smith</td>
+>       <td>25</td>
+>       <td>Los Angeles</td>
+>     </tr>
+>     <tr>
+>       <td>Emily Johnson</td>
+>       <td>40</td>
+>       <td>Chicago</td>
+>     </tr>
+>     <tr>
+>       <td colspan="2"></td>
+>       <td>3</td>
+>     </tr>
+>   </tbody>
+> </table>
+> ```
+> 
+> </details>
+
+## Roadmap
+
+- [x] Avro input
+  - [x] with format options
+- [x] HTML input
+  - [x] handle colspan (skip cells)
+  - [ ] with format options
+- [ ] add testing
+- [ ] add benchmarks
+
+If you have any suggestions, feel free to open an issue.
+
+## Credits
+
+- Huge thanks to [jmcnamara/rust_xlsxwriter](https://github.com/jmcnamara/rust_xlsxwriter) for their amazing excel library
+
+## License
+
+This bundle is under the MIT license.  
+For the whole copyright, see the [LICENSE](./LICENSE) file distributed with this source code.