From 1152db1c7ea4eff41577183b3ca05290a4c8e5a5 Mon Sep 17 00:00:00 2001
From: Chris Carlon <cmcarleone@gmail.com>
Date: Tue, 8 Oct 2024 22:26:13 +0100
Subject: [PATCH] crates release changes

---
 Cargo.toml |  5 +++
 README.md  | 91 +++++++++++++++++++++++++++---------------------------
 2 files changed, 50 insertions(+), 46 deletions(-)

diff --git a/Cargo.toml b/Cargo.toml
index 6a88dac..b5962e8 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -3,6 +3,11 @@ name = "nebby"
 version = "0.1.3"
 edition = "2021"
 
+# Author and License Information
+authors = ["chris@enmeshed.dev"]
+license = "MIT"
+repository = "https://github.com/CHRISCARLON/nebby"
+
 [[bin]]
 name = "nebb"
 path = "src/main.rs"
diff --git a/README.md b/README.md
index 42da43e..c7308ff 100644
--- a/README.md
+++ b/README.md
@@ -1,68 +1,67 @@
 # Nebby 🤥
 
-Nebby is a command-line tool for all you nosey parkers out there.
+Nebby is a command-line tool designed to quickly review basic information about a range of different file formats.
 
-Quickly review basic information about a range of different file formats.
+It provides various commands to interact with Excel, JSON, and CSV files - with more to come!
 
-nebb + command + url and away you go!
+## Features
 
-> [!NOTE]
-> Nebby is currently under active development. Features and commands may change as the project evolves.
+- **Excel File Handling**: Display basic information, check formatting, and quick view essential info.
+- **CSV Support**: Basic CSV sniff feature.
+- **JSON Handling**: Experimental basic API request feature - see how nested an json response is.
+- **File Byte Inspection**: Examine the bytes of any file - useful for getting info on file signatures.
+- **Flexible Command Interface**: Easily extendable with new commands.
 
-## Usage
+## Installation
 
-```
-nebb <COMMAND>
-```
+To install Nebby, use the provided `nebbybuild` script. This script will build and install the binary for you:
 
-## Commands
+1. Clone the repository:
+   ```bash
+   git clone git@github.com:enmeshed-analytics/duckdb-postgis.git
+   cd nebby
+   ```
 
-### `basic`
-Display basic information about an Excel file.
-```
-nebb basic <URL>
-```
+2. Give execute permission to the build script:
+   ```bash
+   chmod +x nebbybuild
+   ```
 
-### `format`
-Check formatting of an Excel file.
-```
-nebb format <URL>
-```
+3. Run the build script:
+   ```bash
+   ./nebbybuild
+   ```
 
-### `quick-view`
-Quick view of an Excel file.
-```
-nebb quick-view <URL>
-```
+This script will build the project in release mode and install the `nebb` binary to `/usr/local/bin/`, making it accessible from anywhere on your system.
 
-### `basic-idx`
-Display basic information about an Excel file with a specified header index.
-This is useful if the header is not on the first row.
-```
-nebb basic-idx <URL> [--header-index <INDEX>]
-```
+## Usage
 
-### `basic-json`
-Make a basic API GET request and display information about how nested the JSON response is.
-```
-nebb basic-json <URL>
+Run Nebby from the command line to access its features:
+
+```bash
+nebb <COMMAND> <URL>
 ```
 
-## Options
+### Commands
 
-- `-h`, `--help`: Print help information
-- `-V`, `--version`: Print version information
+- `basic-xl`: Display basic information about an Excel file.
+- `format-xl`: Check formatting of an Excel file.
+- `quick-view-xl`: Quick view of an Excel file.
+- `basic-idx-xl`: Experimental feature to display basic information with a specified header index.
+- `basic-json`: Experimental basic API request feature.
+- `nibble`: Check bytes of any file.
+- `basic-csv`: Basic CSV feature.
+- `help`: Print help message or the help of the given subcommand(s).
 
-## Roadmap
+### Options
 
-- [ ] Add support for additional file formats
-- ✅ Enhance JSON processing capabilities
-- [ ] TBC
+- `-h`, `--help`: Print help information.
+- `-V`, `--version`: Print version information.
 
-## Author
+## Contributing
 
-Christopher Carlon
+Contributions are welcome! Please fork the repository and submit a pull request for any improvements or bug fixes.
 
-## Version
+## License
 
-0.1.3
+This project is licensed under the MIT License.