add generic api guide

Author: barelyhuman

docs/api.md

@@ -0,0 +1,81 @@
+<!-- meta -->
+<title>
+    commitlog | manual
+</title>
+<meta name="description" content="commits to changelog generator">
+<!-- meta end -->
+
+### [commitlog](/)
+
+[Home](/) [Manual](/manual) [Download &darr;](/download) [API](/api)
+
+# API
+
+### General Guide
+
+commitlog also comes as a pkg that you could reuse to modify the behaviour of
+the commands and this is very limited at the moment since I'm still working on
+the best way to get plugins to work with the original CLI instead of having to
+write your own version of commitlog.
+
+The pkg contains the 2 base command's creators and behaviour modifiers, or more
+commonly known as the golang options pattern.
+
+Briefly put, You have one function that takes in unlimited amount of functions
+as parameter with each of these parameter functions being able to modify the
+behaviour of the returned instance.
+
+Easy way to explain this is with an example of the `releaser` API
+
+```go
+package main
+
+import (
+	"log"
+
+	"github.com/barelyhuman/commitlog/pkg"
+)
+
+func main() {
+	versionString := "v0.0.1"
+	releaser, _ := pkg.CreateNewReleaser(
+		versionString,
+		pkg.WithMajorIncrement(),
+	)
+
+	log.Println(releaser.String())
+
+}
+```
+
+here the `pkg.CreateNewReleaser` takes in one mandatory value which is the
+`versionString` and the 2nd parameter is optional here.
+
+Though, since we wish for the releaser to have a custom behaviour everytime the
+flags change, instead of writing entire functionalities inside various releaser
+functions, which would look like so
+
+```go
+releaser.IncrementMajor()
+releaser.IncrementMinor()
+```
+
+I'd be unable to expose the builders / option functions out to the public for
+them to write custom behaviours that work directly with the `struct` being used
+by commitlog itself and instead you'd be writing wrappers around existing
+functions. Thus, adding another layer of abstraction which isn't needed for
+something that wants to be extended.
+
+This approach gives me the ability to expose a selected few properties for you
+to modify while writing your own builder/option function.
+
+The only pointer functions that releaser has is the one's that'll help with
+printing or identifying the final version's state.
+
+Since, you now know how the API is written, the go doc for this module should be
+able to help you with the remaining.
+
+[godoc&nearr;](https://pkg.go.dev/github.com/barelyhuman/commitlog)
+
+> **Note**: if the go doc still hasn't been generated for v2.0.0, please go
+> through the source code to help you with the implementation details

docs/download.md

@@ -7,8 +7,7 @@
 
 ### [commitlog](/)
 
-[Manual](/manual)\
-[Download ↓](/download)
+[Home](/) [Manual](/manual) [Download ↓](/download) [API](/api)
 
 #### Downloads
 

docs/index.md

@@ -7,8 +7,7 @@
 
 ### [commitlog](/)
 
-[Manual](/manual)\
-[Download ↓](/download)
+[Home](/) [Manual](/manual) [Download ↓](/download) [API](/api)
 
 #### Index
 
@@ -123,4 +122,5 @@ PATH variables
 
 <h4 id="license">License</h4>
 
-commitlog is MIT Licensed and you can read the entire license in the [source code](https://github.com/barelyhuman/commitlog)
+commitlog is MIT Licensed and you can read the entire license in the
+[source code](https://github.com/barelyhuman/commitlog)

docs/manual.md

@@ -7,8 +7,7 @@
 
 ### [commitlog](/)
 
-[Manual](/manual)\
-[Download ↓](/download)
+[Home](/) [Manual](/manual) [Download ↓](/download) [API](/api)
 
 # Manual
 
@@ -20,6 +19,7 @@
   - [From a different repo](#from-a-different-repo)
   - [Categorize](#categorize)
 - [CLI](#cli)
+- [API](/api)
 
 <h3 id="basics">Basics</h3>
 

docs/styles.css

@@ -1,6 +1,5 @@
 @import url("https://fonts.googleapis.com/css2?family=Fira+Code:wght@400;600;700&display=swap");
 
-
 :root {
     --base: #fff;
     --surface: #efefef;
@@ -9,7 +8,7 @@
     --accent: dodgerblue;
 }
 
-@media (prefers-color-scheme:dark) {
+@media (prefers-color-scheme: dark) {
     :root {
         --base: #111;
         --surface: #333;
@@ -99,6 +98,7 @@ pre>code {
 
 a {
     color: inherit;
+    text-underline-offset: 4px;
 }
 
 a:hover {

scripts/get-release-urls.sh

@@ -1,3 +1,4 @@
+
 #!/usr/bin/env bash
 
 curl -sL https://api.github.com/repos/barelyhuman/commitlog/releases | jq '[ .[0].assets[] | {name:.name,url:.url} ]' > api_urls.json
@@ -12,8 +13,9 @@ cat >./docs/download.md<<EOF
 
 ### [commitlog](/)
 
-[Manual](/manual)       
+[Manual](/manual)
 [Download &darr;](/download)
+[API](/api)
 
 #### Downloads