README: move developer notes to separate markdown and add useful links to main README.md (#486)

Author: meekrosoft

README.md

@@ -1,47 +1,13 @@
 [![codecov](https://codecov.io/gh/kosli-dev/cli/branch/main/graph/badge.svg?token=Z4Y53XIOKJ)](https://codecov.io/gh/kosli-dev/cli)
 [![Static Badge](https://img.shields.io/badge/provenance-blue?style=plastic&link=https%3A%2F%2Fapp.kosli.com%2Fkosli-public%2Fflows%2Fcli-release%2Ftrails%2F)](https://app.kosli.com/kosli-public/flows/cli-release/trails/)
 
-# Kosli Reporter
+# Kosli CLI
 
-This CLI is used to report DevOps change events to Kosli and query them.
+This repo contains the Kosli CLI, for recording and querying software delivery events [Kosli](www.kosli.com)
 
-## Status
+Some useful links: 
 
-Kosli is still in beta
-
-## Usage 
-
-See the [docs](https://docs.kosli.com/client_reference/)
-
-## Linting the code
-
-`make lint`
-
-## Building the code (Mac/Linux)
-
-`make build`
-
-Then to run Kosli commands:  
-`./kosli [COMMAND]`
-
-## Building the code (Windows)
-
-Windows will not allow building using the makefile, so we need to run the commands directly in the terminal.
-
-`set GOFLAGS=""`  
-`go mod download`  
-`go mod tidy`  
-`go vet ./...`  
-`go build -o kosli.exe -ldflags '-extldflags "-static"' ./cmd/kosli/`
-
-Then to run Kosli commands:  
-`./kosli.exe [COMMAND]` or `.\kosli.exe [COMMAND]`
-
-## Building the documentation
-
-`make hugo-local`
-
-## Running the tests
-
-To run only the tests in a single test suite, eg TestAttestJunitCommandTestSuite
-`make test_integration_single TARGET=TestAttestJunitCommandTestSuite`
+* [Documentation site](https://docs.kosli.com/client_reference/) for full details on usage.
+* [Developer guide](/dev-guide.md) for details on working with the code in this repo.
+* [Kosli main Trails](https://app.kosli.com/kosli-public/flows/cli/trails/)
+* [Kosli release Trails](https://app.kosli.com/kosli-public/flows/cli-release/trails/)

dev-guide.md

@@ -0,0 +1,43 @@
+[![codecov](https://codecov.io/gh/kosli-dev/cli/branch/main/graph/badge.svg?token=Z4Y53XIOKJ)](https://codecov.io/gh/kosli-dev/cli)
+[![Static Badge](https://img.shields.io/badge/provenance-blue?style=plastic&link=https%3A%2F%2Fapp.kosli.com%2Fkosli-public%2Fflows%2Fcli-release%2Ftrails%2F)](https://app.kosli.com/kosli-public/flows/cli-release/trails/)
+
+# Kosli Reporter
+
+This CLI is used to record and query software delivery events to [Kosli](www.kosli.com).
+
+## Usage 
+
+See the [docs](https://docs.kosli.com/client_reference/)
+
+## Linting the code
+
+`make lint`
+
+## Building the code (Mac/Linux)
+
+`make build`
+
+Then to run Kosli commands:  
+`./kosli [COMMAND]`
+
+## Building the code (Windows)
+
+Windows will not allow building using the makefile, so we need to run the commands directly in the terminal.
+
+`set GOFLAGS=""`  
+`go mod download`  
+`go mod tidy`  
+`go vet ./...`  
+`go build -o kosli.exe -ldflags '-extldflags "-static"' ./cmd/kosli/`
+
+Then to run Kosli commands:  
+`./kosli.exe [COMMAND]` or `.\kosli.exe [COMMAND]`
+
+## Building the documentation
+
+`make hugo-local`
+
+## Running the tests
+
+To run only the tests in a single test suite, eg TestAttestJunitCommandTestSuite
+`make test_integration_single TARGET=TestAttestJunitCommandTestSuite`