diff --git a/.docs/README.md b/.docs/README.md deleted file mode 100644 index 517a4c7e..00000000 --- a/.docs/README.md +++ /dev/null @@ -1,34 +0,0 @@ -# Contributte Datagrid - -- [Introduction](introduction.md) - -**Data sources** -- [Data sources](data-source.md) - -**UI** -- [Columns](columns.md) -- [Filters](filters.md) -- [Localization](localization.md) -- [Pagination](pagination.md) -- [Assets](assets.md) - -**Actions** -- [Actions](actions.md) -- [Group action](group-action.md) - -**Templates** -- [Row](row.md) -- [Templates](template.md) - -**Export** -- [Exports](export.md) - -**State storage** -- [State storage](state-storage.md) - -**Inline** (advanced) -- [Inline edit](inline-edit.md) -- [Inline add](inline-add.md) - -**Tree view** (advanced) -- [Tree view](tree-view.md) diff --git a/README.md b/README.md index 9df3635c..573df38e 100755 --- a/README.md +++ b/README.md @@ -22,35 +22,74 @@ Website 🚀 contributte.org | Contact

-## About +First class datagrid for Nette Framework with filtering, sorting, pagination, tree view, table view, localization, exports and inline editing. -You are looking at first class datagrid for Nette Framework. Supported features: filtering, sorting, pagination, tree view, table view, translator and many others. -Give us a star, it makes us so happy. Thanks ⭐.️ +## Versions + +| State | Version | Branch | Nette | PHP | +|--------|-----------|----------|--------|---------| +| dev | `^7.2.x` | `master` | `3.2+` | `>=8.2` | +| stable | `^7.1.0` | `master` | `3.2+` | `>=8.2` | +| stable | `^7.0.0` | `master` | `3.2+` | `>=8.1` | +| stable | `^6.10.0` | `master` | `3.0+` | `>=7.2` | + +## Installation + +To install latest version of `ublaboo/datagrid` use [Composer](https://getcomposer.org). + +``` +composer require ublaboo/datagrid +``` + +## Resources | Resource | Link | |----------|------| -| **Documentation** | [documentation](.docs) | | **Skeleton Demo** | [https://examples.contributte.org/datagrid-skeleton/](https://examples.contributte.org/datagrid-skeleton/) | | **Skeleton Repository** | [github.com/contributte/datagrid-skeleton](https://github.com/contributte/datagrid-skeleton) | -## Usage +## Topics -To install latest version of `datagrid` use [Composer](https://getcomposer.org). +- [Introduction](.docs/introduction.md) -``` -composer require ublaboo/datagrid -``` +**Data sources** -For details on how to use this package, check out our [documentation](.docs). +- [Data sources](.docs/data-source.md) -## Versions +**UI** -| State | Version | Branch | Nette | PHP | -|--------|-----------|----------|--------|---------| -| dev | `^7.2.x` | `master` | `3.2+` | `>=8.2` | -| stable | `^7.1.0` | `master` | `3.2+` | `>=8.2` | -| stable | `^7.0.0` | `master` | `3.2+` | `>=8.1` | -| stable | `^6.10.0` | `master` | `3.0+` | `>=7.2` | +- [Columns](.docs/columns.md) +- [Filters](.docs/filters.md) +- [Localization](.docs/localization.md) +- [Pagination](.docs/pagination.md) +- [Assets](.docs/assets.md) + +**Actions** + +- [Actions](.docs/actions.md) +- [Group action](.docs/group-action.md) + +**Templates** + +- [Row](.docs/row.md) +- [Templates](.docs/template.md) + +**Export** + +- [Exports](.docs/export.md) + +**State storage** + +- [State storage](.docs/state-storage.md) + +**Inline** (advanced) + +- [Inline edit](.docs/inline-edit.md) +- [Inline add](.docs/inline-add.md) + +**Tree view** (advanced) + +- [Tree view](.docs/tree-view.md) ## Development