Pushed 2025-12-10 08:40:53

Author: eli-sterling

README.md

@@ -1,79 +1,72 @@
 # [![eliware.org](https://eliware.org/logos/brand.png)](https://discord.gg/M6aTR9eTwN)
 
-## @eliware/tagit [![npm version](https://img.shields.io/npm/v/@eliware/tagit.svg)](https://www.npmjs.com/package/@eliware/tagit)[![license](https://img.shields.io/github/license/eliware/tagit.svg)](LICENSE)[![build status](https://github.com/eliware/tagit/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eliware/tagit/actions)
+## @eliware/tagit [![npm version](https://img.shields.io/npm/v/@eliware/tagit.svg)](https://www.npmjs.com/package/@eliware/tagit) [![license](https://img.shields.io/github/license/eliware/tagit.svg)](LICENSE) [![build status](https://github.com/eliware/tagit/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eliware/tagit/actions)
 
-A starter template for new Node.js projects. Use this as a foundation for your next application or service.
+Automated version management and Git operations for Node.js and PHP projects.
+
+**Note:** `tagit` is intended for use on Linux systems only.
 
 ---
 
 ## Table of Contents
 
+- [What is tagit?](#what-is-tagit)
 - [Features](#features)
-- [Getting Started](#getting-started)
-- [Development](#development)
-- [Testing](#testing)
-- [Customization](#customization)
+- [Usage](#usage)
 - [Support](#support)
 - [License](#license)
+- [Links](#links)
 
-## Features
-
-- Pre-configured for Node.js (ESM)
-- Environment variable support via dotenv
-- Logging and signal handling via `@eliware/common`
-- Jest for testing
-- MIT License
+## What is tagit?
 
-## Getting Started
+`tagit` is a CLI utility that automates the process of incrementing your project version, updating version files (`package.json` and/or `composer.json`), committing the changes, tagging the commit, and pushing to your Git repository. It provides detailed logging and robust error handling for a smooth release workflow.
 
-1. **Clone this template:**
-
-   ```bash
-   git clone https://github.com/eliware/tagit.git
-   cd tagit
-   rm -rf .git
-   git init
-   npm install
-   ```
+## Features
 
-2. **Update project details:**
-   - Edit `package.json` (name, description, author, etc.)
-   - Update this `README.md` as needed
-   - Change the license if required
+- Increments the semantic version in `package.json` and/or `composer.json`
+- Writes the new version back to the file(s)
+- Commits all changes with a message like: `Version <version> - MM-DD-YYYY`
+- Tags the commit with the new version
+- Pushes commits and tags to your remote repository
+- Logs each step for transparency
 
-## Development
+## Installation
 
-- Main entry: `tagit.mjs`
-- Start your app:
+Clone the repository (suggested location: `/opt`):
 
-  ```bash
-  node tagit.mjs
-  ```
+```bash
+sudo git clone https://github.com/eliware/tagit.git /opt/tagit
+cd /opt/tagit
+sudo npm install
+# (Optional) Run tests
+sudo npm test
+```
 
-- Add your code in new files and import as needed.
+Create a symlink to make `tagit` available system-wide:
 
-## Testing
+```bash
+sudo ln -s /opt/tagit/tagit.mjs /usr/bin/tagit
+```
 
-- Run tests with:
+## Usage
 
-  ```bash
-  npm test
-  ```
+Switch to the root directory of the project you want to bump the version for, then run:
 
-- Add your tests in the `__tests__` folder or alongside your code.
+```bash
+tagit
+```
 
-## Customization
+If you have not created the symlink, you can run it directly with:
 
-- Replace or extend the logging and signal handling as needed.
-- Add dependencies and scripts to fit your project.
-- Remove or modify template files and sections.
+```bash
+/opt/tagit/tagit.mjs
+```
 
 ## Support
 
-For help, questions, or to chat with the author and community, visit:
-
-[![Discord](https://eliware.org/logos/discord_96.png)](https://discord.gg/M6aTR9eTwN)[![eliware.org](https://eliware.org/logos/eliware_96.png)](https://discord.gg/M6aTR9eTwN)
+For help or questions, join the community and chat with the author:
 
+[![Discord](https://eliware.org/logos/discord_96.png)](https://discord.gg/M6aTR9eTwN)  
 **[eliware.org on Discord](https://discord.gg/M6aTR9eTwN)**
 
 ## License