From 677ed27773ad73db4dbe7723f69dc9b48321d6b5 Mon Sep 17 00:00:00 2001
From: Houkime <>
Date: Mon, 18 Mar 2024 11:55:02 +0000
Subject: [PATCH 1/3] docs(api): add a CI badge

---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index 56ea97c..9ff3705 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 # SelfPrivacy GraphQL API which allows app to control your server
 
+![CI status](https://ci.selfprivacy.org/api/badges/SelfPrivacy/selfprivacy-rest-api/status.svg)
+
 ## build
 
 ```console

From 97960f77f2a6fa1d05139255b97670491281035f Mon Sep 17 00:00:00 2001
From: Houkime <>
Date: Mon, 18 Mar 2024 12:00:33 +0000
Subject: [PATCH 2/3] docs(api): use title case in README

---
 README.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 9ff3705..942cdb2 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 ![CI status](https://ci.selfprivacy.org/api/badges/SelfPrivacy/selfprivacy-rest-api/status.svg)
 
-## build
+## Build
 
 ```console
 $ nix build
@@ -10,7 +10,7 @@ $ nix build
 
 In case of successful build, you should get the `./result` symlink to a folder (in `/nix/store`) with build contents.
 
-## develop
+## Develop
 
 ```console
 $ nix develop
@@ -26,7 +26,7 @@ If you don't have experimental flakes enabled, you can use the following command
 nix --extra-experimental-features nix-command --extra-experimental-features flakes develop
 ```
 
-## testing
+## Testing
 
 Run the test suite by running coverage with pytest inside an ephemeral NixOS VM with redis service enabled:
 ```console
@@ -63,7 +63,7 @@ $ TMPDIR=".nixos-vm-tmp-dir" nix run .#checks.x86_64-linux.default.driverInterac
 
 Option `-L`/`--print-build-logs` is optional for all nix commands. It tells nix to print each log line one after another instead of overwriting a single one.
 
-## dependencies and dependant modules
+## Dependencies and Dependant Modules
 
 This flake depends on a single Nix flake input - nixpkgs repository. nixpkgs repository is used for all software packages used to build, run API service, tests, etc.
 
@@ -87,6 +87,6 @@ $ nix flake metadata git+https://git.selfprivacy.org/SelfPrivacy/selfprivacy-nix
 
 Nix code for NixOS service module for API is located in NixOS configuration repository.
 
-## troubleshooting
+## Troubleshooting
 
 Sometimes commands inside `nix develop` refuse to work properly if the calling shell lacks `LANG` environment variable. Try to set it before entering `nix develop`.

From f2446dcee2b39815012c3e37531b08be683961c3 Mon Sep 17 00:00:00 2001
From: Houkime <>
Date: Mon, 18 Mar 2024 12:01:16 +0000
Subject: [PATCH 3/3] docs(api): add missing dollar sign

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 942cdb2..37ed193 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,7 @@ Type "help", "copyright", "credits" or "license" for more information.
 If you don't have experimental flakes enabled, you can use the following command:
 
 ```console
-nix --extra-experimental-features nix-command --extra-experimental-features flakes develop
+$ nix --extra-experimental-features nix-command --extra-experimental-features flakes develop
 ```
 
 ## Testing