Adjusts readme

README.md

@@ -1,47 +1,39 @@
+
 <p align="center">
-    <img src="https://raw.githubusercontent.com/nunomaduro/skeleton-php/master/docs/example.png" height="300" alt="Skeleton Php">
+    <img src="https://raw.githubusercontent.com/peckphp/peck/main/docs/logo.png" alt="Peck example" height="300">
     <p align="center">
-        <a href="https://github.com/nunomaduro/skeleton-php/actions"><img alt="GitHub Workflow Status (master)" src="https://github.com/nunomaduro/skeleton-php/actions/workflows/tests.yml/badge.svg"></a>
-        <a href="https://packagist.org/packages/nunomaduro/skeleton-php"><img alt="Total Downloads" src="https://img.shields.io/packagist/dt/nunomaduro/skeleton-php"></a>
-        <a href="https://packagist.org/packages/nunomaduro/skeleton-php"><img alt="Latest Version" src="https://img.shields.io/packagist/v/nunomaduro/skeleton-php"></a>
-        <a href="https://packagist.org/packages/nunomaduro/skeleton-php"><img alt="License" src="https://img.shields.io/packagist/l/nunomaduro/skeleton-php"></a>
+        <a href="https://github.com/peckphp/peck/actions"><img alt="GitHub Workflow Status (master)" src="https://img.shields.io/github/actions/workflow/status/peckphp/peck/tests.yml"></a>
+        <a href="https://packagist.org/packages/peckphp/peck"><img alt="Total Downloads" src="https://img.shields.io/packagist/dt/peckphp/peck"></a>
+        <a href="https://packagist.org/packages/peckphp/peck"><img alt="Latest Version" src="https://img.shields.io/packagist/v/peckphp/peck"></a>
+        <a href="https://packagist.org/packages/peckphp/peck"><img alt="License" src="https://img.shields.io/packagist/l/peckphp/peck"></a>
     </p>
 </p>
 
 ------
-This package provides a wonderful **PHP Skeleton** to start building your next package idea.
+**Peck** is a CLI tool that detects wording / or spelling mistakes in your codebase. It is designed to be fast, easy to use and integrate into your workflow.
 
-> **Requires [PHP 8.3+](https://php.net/releases/)**
+It relies on the [github.com/tigitz/php-spellchecker](https://github.com/tigitz/php-spellchecker) to detect spelling mistakes in your codebase, the goal to make it work with Folder names, file names, method names, comments, and more.
 
-⚡️ Create your package using [Composer](https://getcomposer.org):
+> **Note:** This project is still in development and not ready for production use. At the moment, only the filesystem checker is implemented.
 
-```bash
-composer create-project nunomaduro/skeleton-php --prefer-source PackageName
-```
+## Installation
 
-🧹 Keep a modern codebase with **Pint**:
-```bash
-composer lint
-```
+> **Requires [PHP 8.3+](https://php.net/releases/)**
 
-✅ Run refactors using **Rector**
-```bash
-composer refacto
-```
+Require Peck using [Composer](https://getcomposer.org):
 
-⚗️ Run static analysis using **PHPStan**:
 ```bash
-composer test:types
+composer require peckphp/peck
 ```
 
-✅ Run unit tests using **PEST**
-```bash
-composer test:unit
-```
+## Usage
+
+To check your project for spelling mistakes, run the following command:
 
-🚀 Run the entire test suite:
 ```bash
-composer test
+./vendor/bin/peck
 ```
 
-**Skeleton PHP** was created by **[Nuno Maduro](https://twitter.com/enunomaduro)** under the **[MIT license](https://opensource.org/licenses/MIT)**.
+---
+
+Peck is an open-sourced software licensed under the **[MIT license](https://opensource.org/licenses/MIT)**.