diff --git a/README.md b/README.md index c744233..42a9174 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,26 @@ Drupal development and other Drupal related tasks. Missing a tool here? Just fork the repo and add your tool as a `.yml` in the `_data/projects` folder. +```yaml +# _data/projects/example-tool.yml +name: Example Tool +year_created: 2024 +source: https://github.com/example/example-tool +homepage: https://example.com +description: | + A single sentence that will appear in the listings. +requires: + - php +drupal_versions: + - 10 +category: + - devops +recommended: true +``` + +Use the same keys shown above so the site build picks up the metadata correctly. +Optional keys such as `docs`, `logo`, or `similar` can be added when the information is available. + Make sure to follow the following rules: - **Open Source:** The tool must have a public repository on Github, Gitlab, Bitbucket etc that we can link to and pull in stats from. diff --git a/about.html b/about.html index f83f5d5..5d25f4a 100644 --- a/about.html +++ b/about.html @@ -21,6 +21,25 @@ Feel free to use this website and **add a missing tool at the `_data/projects` folder**. +```yaml +name: My Tool +year_created: 2024 +source: https://github.com/example/my-tool +homepage: https://example.com +description: | + Short, human readable copy that appears on the listings page. +requires: + - php +drupal_versions: + - 10 +category: + - devops +recommended: true +``` + +Copy the structure above, update the values, and submit a pull request with the new file. Include optional fields like `docs`, +`logo`, or `similar` when those links are available. + ## Issues Add an issue at [github.com/theodorosploumis/drupaltools/issues](https://github.com/theodorosploumis/drupaltools/issues)