Skip to content

Commit

Permalink
docs: add docs/installation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jeandanyel committed Nov 14, 2024
1 parent 14f9136 commit df65e24
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ The system is built to integrate with nearly any list library, though currently,

This bundle is actively under development, with the next feature being the addition of filters and search functionality. Contributions to the project are welcome 🥳.

- [Installation](docs/installation.md)
- [Install list library dependencies](docs/installation.md#install-list-library-dependencies)
- [Build a list](docs/build-a-list.md)
- [Create a list type class](docs/build-a-list.md#create-a-list-type-class)
- [Create a list in a controller](docs/build-a-list.md#create-a-list-in-a-controller)
Expand Down
3 changes: 1 addition & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
"doctrine/doctrine-bundle": "^2.12",
"doctrine/orm": "^3.1",
"symfony/translation": "^6.4|^7.0",
"symfony/asset-mapper": "^6.4|^7.0",
"symfony/asset": "^6.4|^7.0",
"symfony/form": "^6.4|^7.0",
"symfony/framework-bundle": "^6.4|^7.0",
Expand All @@ -26,7 +25,7 @@
},
"extra": {
"symfony": {
"allow-contrib": false,
"allow-contrib": true,
"require": "^6.4 || ^7.0"
}
}
Expand Down
17 changes: 17 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Installation

Install the bundle using Composer.

```bash
composer require jeandanyel/list-bundle
```

## Install list library dependencies

You must manually install the dependencies for the list library you will use.

### GridJS.io

Install the dependencies via [NPM](https://www.npmjs.com/package/gridjs) or [Symfony AssetMapper](https://symfony.com/doc/current/frontend/asset_mapper.html).

Refer to the [official GridJS documentation](https://gridjs.io/docs/install) for more details.

0 comments on commit df65e24

Please sign in to comment.