gh docs scaffolding

sweikenb · Sep 29, 2023 · e89f4ca · e89f4ca
1 parent c382a04
commit e89f4ca
Show file tree

Hide file tree

Showing 9 changed files with 38 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ Simple and easy to use thread-based process manager for PHP based on default PCN
 
 **Further information:**
 
-- [Docs](docs/index.md)
+- [Docs](https://sweikenb.github.io/pcntl/)
 - [Changelog](CHANGELOG.md)
 - [MIT License](LICENSE.txt)
 

diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -1,3 +1,33 @@
 # Summary
 
-- [Chapter 1](./chapter_1.md)
+# Installation
+
+Install the latest version using [composer](https://getcomposer.org/):
+
+```bash
+composer require sweikenb/pcntl
+```
+
+## System Requirements
+
+This library requires at least **PHP v8.2** with the following extensions enabled:
+
+- `pcntl`
+- `posix`
+- `sockets`
+
+Note that this library is **incompatible** with the `grpc` extension!
+
+In order to execute the unit-tests you will need to run them in a linux environment.
+
+# Features
+
+- [Process Manager](features/process-manager.md)
+- [Process Queue](features/process-queue.md)
+- [Inter Process Communication (IPC)](features/ipc.md)
+
+# Examples
+
+- [Async Workloads](examples/async-workloads.md)
+- [Queued Parallel-Processing](examples/queued-processing.md)
+- [IPC Examples](examples/ipc-examples.md)
diff --git a/docs/src/chapter_1.md b/docs/src/chapter_1.md
diff --git a/docs/src/examples/async-workloads.md b/docs/src/examples/async-workloads.md
@@ -0,0 +1 @@
+# Async Workloads
diff --git a/docs/src/examples/ipc-examples.md b/docs/src/examples/ipc-examples.md
@@ -0,0 +1 @@
+# IPC Examples
diff --git a/docs/src/examples/queued-processing.md b/docs/src/examples/queued-processing.md
@@ -0,0 +1 @@
+# Queued Processing
diff --git a/docs/src/features/ipc.md b/docs/src/features/ipc.md
@@ -0,0 +1 @@
+# Inter Process Communication (IPC)
diff --git a/docs/src/features/process-manager.md b/docs/src/features/process-manager.md
@@ -0,0 +1 @@
+# Process Manager
diff --git a/docs/src/features/process-queue.md b/docs/src/features/process-queue.md
@@ -0,0 +1 @@
+# Process Queue