add: development tips

ulcuber · Jan 18, 2024 · 7851031 · 7851031
1 parent d260875
commit 7851031
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 1 deletion.
diff --git a/_docs/0.Home.md b/_docs/0.Home.md
@@ -8,3 +8,4 @@ This package allows you to keep track of each one of your logs stored under `sto
 2.  [Configuration](2.Configuration.md)
 3.  [Usage](3.Usage.md)
 4.  [FAQ](4.FAQ.md)
+5.  [Development](5.Development.md)
diff --git a/_docs/1.Installation-and-Setup.md b/_docs/1.Installation-and-Setup.md
@@ -6,6 +6,7 @@
 2.  [Configuration](2.Configuration.md)
 3.  [Usage](3.Usage.md)
 4.  [FAQ](4.FAQ.md)
+5.  [Development](5.Development.md)
 
 ## Application Requirements
 
@@ -70,6 +71,19 @@ Laravel uses the [Monolog PHP logging library](https://github.com/Seldaek/monolo
 
 ## Composer
 
+For this fork add to `composer.json`:
+
+```json
+"repositories": [
+    {
+        "type": "git",
+        "url": "https://github.com/ulcuber/LogViewer.git"
+    },
+],
+```
+
+Then `composer require arcanedev/log-viewer:9.x-dev`
+
 You can install this package via [Composer](http://getcomposer.org/) by running this command: `composer require arcanedev/log-viewer:{x.x}` where **x.x** is the version compatible with your laravel's version.
 
 E.g `composer require arcanedev/log-viewer:~4.6.0` for Laravel **v5.7**.

diff --git a/_docs/2.Configuration.md b/_docs/2.Configuration.md
@@ -6,6 +6,7 @@
 2.  [Configuration](2.Configuration.md)
 3.  [Usage](3.Usage.md)
 4.  [FAQ](4.FAQ.md)
+5.  [Development](5.Development.md)
 
 See [Config](https://github.com/ulcuber/LogViewer/blob/v9.x/config/log-viewer.php)
 

diff --git a/_docs/3.Usage.md b/_docs/3.Usage.md
@@ -6,6 +6,7 @@
   2. [Configuration](2.Configuration.md)
   3. [Usage](3.Usage.md)
   4. [FAQ](4.FAQ.md)
+  5. [Development](5.Development.md)
 
 
 Start by using this url/route : http://yourdomain.com/log-viewer

diff --git a/_docs/4.FAQ.md b/_docs/4.FAQ.md
@@ -6,5 +6,6 @@
   2. [Configuration](2.Configuration.md)
   3. [Usage](3.Usage.md)
   4. [FAQ](4.FAQ.md)
-
+  5. [Development](5.Development.md)
+
 > Coming soon...
diff --git a/_docs/5.Development.md b/_docs/5.Development.md
@@ -0,0 +1,33 @@
+# 4. Development
+
+## Table of contents
+
+  1. [Installation and Setup](1.Installation-and-Setup.md)
+  2. [Configuration](2.Configuration.md)
+  3. [Usage](3.Usage.md)
+  4. [FAQ](4.FAQ.md)
+  5. [Development](5.Development.md)
+
+
+### Using in project
+
+Clone LogViewer repo
+
+```bash
+git clone [email protected]:ulcuber/LogViewer.git
+```
+
+Add to `composer.json` of your project to use local version:
+
+```json
+"repositories": [
+    {
+        "type": "path",
+        "url": "~/common/php/ulcuber/LogViewer"
+    },
+],
+```
+
+Then `composer require arcanedev/log-viewer:9.x-dev`
+
+It will create symlink from local repo to vendor