From d83b567368c1b466276ac7bf9fbdbf32207941c6 Mon Sep 17 00:00:00 2001
From: Oh My Felix
Date: Tue, 23 Jun 2026 15:39:13 +0000
Subject: [PATCH 1/2] Docs: move documentation to README.
Co-authored-by: Felix
---
.docs/README.md | 33 ---------------------------------
README.md | 40 ++++++++++++++++++++++++++++++----------
2 files changed, 30 insertions(+), 43 deletions(-)
delete mode 100644 .docs/README.md
diff --git a/.docs/README.md b/.docs/README.md
deleted file mode 100644
index 364b904..0000000
--- a/.docs/README.md
+++ /dev/null
@@ -1,33 +0,0 @@
-# Contributte > DEV
-
-## Content
-
-- [Install](#install)
-- [Usage](#usage)
-
-## Install
-
-```bash
-composer require contributte/dev
-```
-
-## Usage
-
-```php
- * @function d - dump;
- * @function dd - dump; die;
- * @function ed - echo; die;
- * @function fd - foreach dump;
- * @function fdd - foreach dump; die;
- * @function td - table dump;
- * @function tdd - table dump; die;
- * @function bd - barDump;
- * @function wc - where called (backtrace)
- * @function ss - convert to shortcut;
- * @function e - show debug bar;
- * @function l - log message
- * @function erd - throw error and dump parameters
- * @function c - return instance
- * @function cl - clone instance
- * @function callback - call object method
-```
diff --git a/README.md b/README.md
index 7f1be02..92b7f0d 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,16 @@
Website 🚀 contributte.org | Contact 👨🏻💻 f3l1x.io | Twitter 🐦 @contributte
-## Usage
+Development helpers and shortcuts for Nette and Tracy projects.
+
+## Versions
+
+| State | Version | Branch | Nette | PHP |
+|-------------|---------|----------|-------|---------|
+| dev | `^0.6` | `master` | 4.0+ | `>=8.2` |
+| stable | `^0.5` | `master` | 3.1+ | `>=8.1` |
+
+## Installation
To install latest version of `contributte/dev` use [Composer](https://getcomposer.org).
@@ -26,17 +35,28 @@ To install latest version of `contributte/dev` use [Composer](https://getcompose
composer require contributte/dev
```
-## Documentation
-
-For details on how to use this package, check out our [documentation](.docs).
+## Usage
-## Versions
-
-| State | Version | Branch | Nette | PHP |
-|-------------|---------|----------|-------|---------|
-| dev | `^0.6` | `master` | 4.0+ | `>=8.2` |
-| stable | `^0.5` | `master` | 3.1+ | `>=8.1` |
+The package registers several global development shortcuts through Composer autoloading.
+```php
+ * @function d - dump;
+ * @function dd - dump; die;
+ * @function ed - echo; die;
+ * @function fd - foreach dump;
+ * @function fdd - foreach dump; die;
+ * @function td - table dump;
+ * @function tdd - table dump; die;
+ * @function bd - barDump;
+ * @function wc - where called (backtrace)
+ * @function ss - convert to shortcut;
+ * @function e - show debug bar;
+ * @function l - log message
+ * @function erd - throw error and dump parameters
+ * @function c - return instance
+ * @function cl - clone instance
+ * @function callback - call object method
+```
## Development
From 3d2376e40d095246f791964f285b9fbbe9e4c5b3 Mon Sep 17 00:00:00 2001
From: Oh My Felix
Date: Tue, 7 Jul 2026 17:05:24 +0000
Subject: [PATCH 2/2] Docs: polish README migration
---
README.md | 36 ++++++++++++++++++------------------
1 file changed, 18 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
index 92b7f0d..adbe795 100644
--- a/README.md
+++ b/README.md
@@ -39,24 +39,24 @@ composer require contributte/dev
The package registers several global development shortcuts through Composer autoloading.
-```php
- * @function d - dump;
- * @function dd - dump; die;
- * @function ed - echo; die;
- * @function fd - foreach dump;
- * @function fdd - foreach dump; die;
- * @function td - table dump;
- * @function tdd - table dump; die;
- * @function bd - barDump;
- * @function wc - where called (backtrace)
- * @function ss - convert to shortcut;
- * @function e - show debug bar;
- * @function l - log message
- * @function erd - throw error and dump parameters
- * @function c - return instance
- * @function cl - clone instance
- * @function callback - call object method
-```
+| Shortcut | Description |
+|----------|-------------|
+| `d` | Dump value |
+| `dd` | Dump value and terminate |
+| `ed` | Echo value and terminate |
+| `fd` | Dump values in a foreach loop |
+| `fdd` | Dump values in a foreach loop and terminate |
+| `td` | Dump table |
+| `tdd` | Dump table and terminate |
+| `bd` | Dump value to Tracy bar |
+| `wc` | Show where the call came from (backtrace) |
+| `ss` | Convert value to shortcut |
+| `e` | Show debug bar |
+| `l` | Log message |
+| `erd` | Throw error and dump parameters |
+| `c` | Return instance |
+| `cl` | Clone instance |
+| `callback` | Call object method |
## Development