Skip to content

Docs: move documentation to README #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ohmyfelix wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Docs: move documentation to README #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d83b567
Docs: move documentation to README.
ohmyfelix Jun 23, 2026
3d2376e
Docs: polish README migration
ohmyfelix Jul 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 0 additions & 33 deletions .docs/README.md
View file
Open in desktop

This file was deleted.

40 changes: 30 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,25 +18,45 @@
Website 🚀 <a href="https://contributte.org">contributte.org</a> | Contact 👨🏻‍💻 <a href="https://f3l1x.io">f3l1x.io</a> | Twitter 🐦 <a href="https://twitter.com/contributte">@contributte</a>
</p>

## 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).

```bash
composer require contributte/dev
```

## Documentation

For details on how to use this package, check out our [documentation](.docs).

## Versions
## Usage

| 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.

| 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

Expand Down