From 4df9143eb65e2a737ab0cc228109987e6e1a19bc Mon Sep 17 00:00:00 2001
From: Taylor Monacelli <taylormonacelli@gmail.com>
Date: Wed, 24 Jul 2024 14:16:17 -0700
Subject: [PATCH] readme

---
 README.md | 43 +++++++++++++++++++++++++++++++++++--------
 1 file changed, 35 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 7b4ba10..7de62f2 100644
--- a/README.md
+++ b/README.md
@@ -2,29 +2,56 @@
 
 Purpose:
 
+littlewill is a tool for cleaning up Markdown links by removing extra spaces within the link text.
 
-## example usage
+## Example Usage
 
 ```bash
+littlewill input.md > output.md
+```
 
+## Install littlewill
 
+On macOS/Linux:
+```bash
+brew install gkwa/homebrew-tools/littlewill
 ```
 
-## install littlewill
+On Windows:
+```powershell
+TBD
+```
 
+## Running Tests
 
-on macos/linux:
-```bash
+To run the tests for littlewill, follow these steps:
 
-brew install gkwa/homebrew-tools/littlewill
+1. Ensure you have Go installed on your system.
+2. Navigate to the project root directory.
+3. Run the following command:
 
+```bash
+go test ./...
 ```
 
+This will run all tests in the project, including the ones in the `core` package.
 
-on windows:
+To run tests with verbose output:
 
-```powershell
+```bash
+go test -v ./...
+```
 
-TBD
+To run a specific test:
 
+```bash
+go test -v ./core -run TestCleanupMarkdownLinks
 ```
+
+Replace `TestCleanupMarkdownLinks` with the name of the specific test you want to run.
+
+## Development
+
+The main functionality is implemented in the `core/cleanup.go` file. Tests are located in `core/cleanup_test.go`.
+
+To contribute or modify the code, make sure to run the tests after any changes to ensure everything is working as expected.