From 3a5eb5c548f080d3696e5a00c51881a5337d2e5a Mon Sep 17 00:00:00 2001
From: plup <plup@plup.io>
Date: Sun, 29 Mar 2020 16:11:31 +0200
Subject: [PATCH] doc: added changelog, wrote doc for usage

---
 CHANGELOG.md                  |  5 +++++
 docs/howto_use_client_beta.md | 27 +++++++++++++++++++++++++++
 docs/testing_client.md        | 29 +++++++++++++++++++++++++++++
 docs/using_client.md          | 17 -----------------
 4 files changed, 61 insertions(+), 17 deletions(-)
 create mode 100644 CHANGELOG.md
 create mode 100644 docs/howto_use_client_beta.md
 create mode 100644 docs/testing_client.md
 delete mode 100644 docs/using_client.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 00000000..24b82b38
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+## Unreleased
+
+* Imported CLI along with development template from sib-manager project
diff --git a/docs/howto_use_client_beta.md b/docs/howto_use_client_beta.md
new file mode 100644
index 00000000..5e206951
--- /dev/null
+++ b/docs/howto_use_client_beta.md
@@ -0,0 +1,27 @@
+# How to use the client in beta
+
+`/!\` The client only works for development projects.
+
+Install the appropriate version of the client:
+```
+$ python -m pip install 'git+https://git.startinblox.com/djangoldp-packages/djangoldp.git@v0.7.dev1'
+```
+
+Setup a new project:
+```
+$ djangoldp startproject myproject
+$ cd myproject
+```
+
+Configure the `config.yml` with the dependencies and the LDP packages your server need to serve.
+
+Install the server:
+```
+$ djangoldp install
+$ djangoldp configure
+```
+
+Run it:
+```
+$ djangoldp runserver
+```
diff --git a/docs/testing_client.md b/docs/testing_client.md
new file mode 100644
index 00000000..c81be89f
--- /dev/null
+++ b/docs/testing_client.md
@@ -0,0 +1,29 @@
+# Testing the client in docker
+
+## With SQLite backend
+
+Setup the project:
+```
+# docker run --rm -v $PWD:/code -w /code -p 127.0.0.1:8000:8000 -it python:3.6 bash
+# pip install .
+# cd /tmp/
+# djangoldp startproject myproject
+# cd myproject
+# djangoldp install
+# djangoldp configure
+```
+
+Play with it:
+```
+# djangoldp runserver
+```
+
+## With PostgreSQL backend
+
+```
+# docker network create sib
+# docker run --rm --network sib --name postgres -e POSTGRES_DB=sib -e POSTGRES_USER=sib -e POSTGRES_PASSWORD=test -d postgres
+# docker run --rm --network sib -p 127.0.0.1:80:8000 -v $PWD:/code -it happydev1/sib:3.6 bash
+# pip install --user -e .[dev]
+# bash tests/integration/run_test.sh
+```
diff --git a/docs/using_client.md b/docs/using_client.md
deleted file mode 100644
index 0b75d685..00000000
--- a/docs/using_client.md
+++ /dev/null
@@ -1,17 +0,0 @@
-# Using the client
-
-Setup the project:
-```
-# docker run --rm -v $PWD:/code -w /code -p 127.0.0.1:8000:8000 -it python:3.6 bash
-# pip install .
-# cd /tmp/
-# djangoldp startproject myproject
-# cd myproject
-# djangoldp install
-# djangoldp configure
-```
-
-Play with it:
-```
-# djangoldp runserver
-```
-- 
GitLab