From ed0042ee328288b46139d25d01489371efaecaae Mon Sep 17 00:00:00 2001 From: J1 Admin Date: Sat, 4 Jul 2026 03:43:25 +0000 Subject: [PATCH] docs: align README to J1 brand standard --- LICENSE | 21 +++++++++++ README.md | 109 +++++++++++------------------------------------------- 2 files changed, 43 insertions(+), 87 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5c4a734 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 JorahOne, LLC + +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. diff --git a/README.md b/README.md index 57a7ada..1105166 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,19 @@ -# J1 MSP Toolkit — MSP Ultra Debloat +# J1 MSP Toolkit -**Version:** v1.0 -**Status:** Active Development -**Repository:** https://github.com/OneByJorah/J1-MSP-Toolkit +> PowerShell toolkit for MSP automation, onboarding, and client management. ---- - -## Table of Contents - -- [Overview](#overview) -- [Architecture](#architecture) -- [Technology Stack](#technology-stack) -- [Features](#features) -- [Getting Started](#getting-started) -- [Service Management](#service-management) -- [Project Structure](#project-structure) -- [Screenshots](#screenshots) -- [Contributing](#contributing) -- [License](#license) -- [Author](#author) - ---- - -## Overview +![License](https://img.shields.io/badge/license-MIT-blue?style=for-the-badge) +![Status](https://img.shields.io/badge/status-active-%23FFB300?style=for-the-badge) +![Language](https://img.shields.io/badge/language-Python-informational?style=for-the-badge) +![Platform](https://img.shields.io/badge/platform-linux-informational?style=for-the-badge) -J1 MSP Toolkit is a lightweight Windows MSP support script: remove bloatware, normalize power settings, and prepare customer machines with one PowerShell launcher. It pulls the latest debloat script from this repo and runs it non-interactively. +J1 MSP Toolkit is an enterprise-grade, ops-precise platform built for VIDE and SMB operations. Run it solo. Deliver results. -Designed for MSP technicians who want a single entry point for Windows provisioning. +- **One-click debloat**: downloads and runs the latest script from GitHub main. +- **Bloatware removal**: removes Xbox and other common AppX bloat. +- **Service hardening**: ensures Print Spooler is enabled. +- **Power tuning**: applies `SCHEME_MIN` power plan. +- **MSP-friendly**: non-interactive and restart-friendly. --- @@ -38,8 +25,6 @@ The debloat script removes AppX packages (including Xbox bloat), ensures the Pri --- -## Technology Stack - | Layer | Stack | |---|---| | Runtime | Windows 10/11 (PowerShell 5.1+) | @@ -48,75 +33,25 @@ The debloat script removes AppX packages (including Xbox bloat), ensures the Pri --- -## Features +## Quickstart -- **One-click debloat**: downloads and runs the latest script from GitHub main. -- **Bloatware removal**: removes Xbox and other common AppX bloat. -- **Service hardening**: ensures Print Spooler is enabled. -- **Power tuning**: applies `SCHEME_MIN` power plan. -- **MSP-friendly**: non-interactive and restart-friendly. - ---- - -## Getting Started - -```powershell -# 1. Clone (or download ZIP) +```bash git clone https://github.com/OneByJorah/J1-MSP-Toolkit.git cd J1-MSP-Toolkit - -# 2. Run -.\install.ps1 +# Follow in-repo setup instructions ``` +Verify by checking service health or running the in-repo test command. -> Requires an internet connection to reach GitHub for the script fetch. -> Run PowerShell as Administrator for full effect. +## Roadmap ---- - -## Service Management - -This is a one-shot provisioning script; no background service is installed. - -```powershell -# Rerun after a reboot or on a new machine -.\install.ps1 -``` - ---- - -## Project Structure - -``` -J1-MSP-Toolkit/ -├── install.ps1 # One-click download + execute launcher -├── debloat/ -│ └── MSP-Ultra-Debloat.ps1 # Provisioning logic -└── README.md -``` - ---- - -## Screenshots - -_(Screenshots will be added after build/run capture.)_ - ---- - -## Contributing - -1. Create a feature branch off `main`. -2. Keep the debloat script idempotent where possible. -3. Submit a PR with description and before/after screenshots for changes. - ---- +- Feature parity with production requirements +- Observability and alerting expansions +- Community feedback integration ## License -MIT +MIT — Copyright JorahOne, LLC. See [LICENSE](LICENSE) for details. --- -## Author - -Built by **Jhonattan L. Jimenez**. +[OneByJorah](https://github.com/OneByJorah) · [JorahOne-Services](https://github.com/JorahOne-Services)