Skip to content

Docs: move documentation to README #41

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 #41

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
b1d86bd
Docs: move documentation to README
ohmyfelix Jun 23, 2026
1df0af7
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
55 changes: 0 additions & 55 deletions .docs/README.md
View file
Open in desktop

This file was deleted.

64 changes: 54 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,30 +18,74 @@
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
Generate Nextras ORM entities from an existing database schema with configurable output for together or separated model layouts.

## Versions

| State | Version | Branch | PHP |
|-------------|---------|----------|----------|
| dev | `^0.7` | `master` | `>= 8.1` |
| stable | `^0.6` | `master` | `>= 8.1` |

## Installation

To install the latest version of `contributte/nextras-orm-generator` use [Composer](https://getcomposer.org).

```bash
composer require contributte/nextras-orm-generator
composer require --dev contributte/nextras-orm-generator
```

## Documentation
This script does not need to be part of your project, so you can install it anywhere you like and provide a path to the desired directory where entities will be generated.

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

## Versions
### Generate All Entities Together

| State | Version | Branch | PHP |
|-------------|---------|----------|----------|
| dev | `^0.7` | `master` | `>= 8.1` |
| stable | `^0.6` | `master` | `>= 8.1` |
```php
$config = [
'output' => __DIR__ . '/model/together',
// Other options
];
$factory = new SimpleFactory(
new TogetherConfig($config),
new DatabaseAnalyser('mysql:host=127.0.0.1;dbname=nextras_orm_generator', 'root')
);

$factory->create()->generate();
```

### Generate Entities Separately

```php
$config = [
'output' => __DIR__ . '/model/separated',
// Other options
];
$factory = new SimpleFactory(
new SeparateConfig($config),
new DatabaseAnalyser('mysql:host=127.0.0.1;dbname=nextras_orm_generator', 'root')
);

$factory->create()->generate();
```

You can also see example in our playground at [contributte/playground](https://github.com/contributte/playground/tree/master/nextras-orm-generator).

To try the bundled SQLite example locally, run:

```bash
php examples/together.php
```

## Configuration

This tool is highly configurable. Take a look at [configuration classes](src/Config) for list of all available options.

## Development

See [how to contribute](https://contributte.org/contributing.html) to this package.

This package is currently maintaining by these authors.
This package is currently maintained by these authors.

<a href="https://github.com/f3l1x">
<img width="80" height="80" src="https://avatars2.githubusercontent.com/u/538058?v=3&s=80">
Expand Down