From efb09fc08a69e8e702563a76456508a2734641c1 Mon Sep 17 00:00:00 2001
From: jurgenhaas <juergen@paragon-es.de>
Date: Tue, 12 Jan 2021 14:30:09 +0100
Subject: [PATCH] Move readme to docs
---
README.md | 30 ------------------------------
composer.json | 3 ++-
2 files changed, 2 insertions(+), 31 deletions(-)
delete mode 100644 README.md
diff --git a/README.md b/README.md
deleted file mode 100644
index a262dec..0000000
--- a/README.md
+++ /dev/null
@@ -1,30 +0,0 @@
-# Ahoy support for Drupal projects
-
-This is a composer plugin which prepares your local development environment for Ahoy using the framework from [Ahoy-CLI](https://github.com/ahoy-cli/ahoy).
-
-If you [installed Ahoy-CLI](https://github.com/ahoy-cli/ahoy#installation) globally once you can use it in Drupal projects without any further configuration.
-
-## Ahoy within the L3D framework
-
-It currently scans all composer packages with the pattern `lakedrops/*` and collects all their Ahoy commands and makes them available in the root of the main project automatically.
-
-## Prepare a LakeDrops plugin for Ahoy
-
-When your comploser plugin should support this Ahoy framework, simply create a file called `.ahoy.l3d.yml` in the root of your plugin with content similar to this:
-
-```yaml
-ahoyapi: v2
-commands:
- name1:
- imports:
- - file1.yml
- usage: Description of the commands in the external file 1
- name2:
- imports:
- - file2.yml
- usage: Description of the commands in the external file 2
-```
-
-You can use your own names (instead of `name1` and `name2`) and then import any number of files which then contain your real Ahoy commands for this plugin section.
-
-When Ahoy later imports those files into your main root project, it will make sure to resolve the full path to the imported files properly.
diff --git a/composer.json b/composer.json
index 0d949cc..f34177e 100644
--- a/composer.json
+++ b/composer.json
@@ -27,7 +27,8 @@
],
"support": {
"issues": "https://gitlab.lakedrops.com/composer/plugin/ahoy/issues",
- "source": "https://gitlab.lakedrops.com/composer/plugin/ahoy/tree/master"
+ "source": "https://gitlab.lakedrops.com/composer/plugin/ahoy/tree/master",
+ "docs": "https://devops-tools.docs.lakedrops.com/composer/plugin/ahoy/"
},
"require": {
"php": ">=7.2",
--
GitLab