[doc] better org

Author: lispyclouds

README.md

@@ -12,38 +12,37 @@ What if you can influence the CLI behaviour from the server? This enables you to
 
 ## Getting started
 
-### Status
-
-Alpha, looking for design/usage feedback!
-
-### Ideally support:
-- more of the OpenAPI types and their checks. eg arrays, enums, objects, multi types etc
-- type checking request bodies of certain MIME types eg, `application/json`
-- better handling of request bodies eg, providing a stdin or a curl like notation for a file `@payload.json` etc.
-
-### Installation
-
-```bash
-go get github.com/lispyclouds/climate
-```
-
 ### Rationale
 
 climate allows the server to influence the CLI behaviour by using OpenAPI's [extensions](https://swagger.io/docs/specification/v3_0/openapi-extensions/). It encourages [spec-first](https://www.atlassian.com/blog/technology/spec-first-api-development) practices thereby keeping both users and maintenance manageable. It does just enough to handle the spec and nothing more.
 
 Overall, the way it works:
+
 - Each operation is converted to a Cobra command
 - Each parameter is converted to a flag with its corresponding type
 - As of now, request bodies are a flag and treated as a string regardless of MIME type. Name defaults to `climate-data` unless specified via `x-cli-name`. All subject to change
 - The provided handlers are attached to each command, grouped and attached to the rootCmd
 
 Influenced by some of the ideas behind [restish](https://rest.sh/) it uses the following extensions as of now:
+
 - `x-cli-aliases`: A list of strings which would be used as the alternate names for an operation
 - `x-cli-group`: A string to allow grouping subcommands together. All operations in the same group would become subcommands in that group name
 - `x-cli-hidden`: A boolean to hide the operation from the CLI menu. Same behaviour as a cobra command hide: it's present and expects a handler
 - `x-cli-ignored`: A boolean to tell climate to omit the operation completely
 - `x-cli-name`: A string to specify a different name. Applies to operations and request bodies as of now
 
+### Ideally support:
+
+- more of the OpenAPI types and their checks. eg arrays, enums, objects, multi types etc
+- type checking request bodies of certain MIME types eg, `application/json`
+- better handling of request bodies eg, providing a stdin or a curl like notation for a file `@payload.json` etc.
+
+### Installation
+
+```bash
+go get github.com/lispyclouds/climate
+```
+
 ### Usage
 
 Given an OpenAPI spec like [api.yaml](/api.yaml)
@@ -65,6 +64,7 @@ rootCmd := &cobra.Command{
 ```
 
 Define one or more handler functions of the following signature:
+
 ```go
 func handler(opts *cobra.Command, args []string, data climate.HandlerData) error {
 	slog.Info("called!", "data", fmt.Sprintf("%+v", data))
@@ -73,13 +73,15 @@ func handler(opts *cobra.Command, args []string, data climate.HandlerData) error
 	return err
 }
 ```
+
 #### Handler Data
 
 (Feedback welcome to make this better!)
 
 As of now, each handler is called with the cobra command it was invoked with, the args and an extra `climate.HandlerData`, more info [here](https://pkg.go.dev/github.com/lispyclouds/climate#pkg-types)
 
 This can be used to query the params from the command mostly in a type safe manner:
+
 ```go
 // to get all the int path params
 for _, param := range data.PathParams {
@@ -182,6 +184,7 @@ $ go run main.go ops add-get --n1 1 --n2 2
 ```
 
 ## License
+
 Copyright © 2024- Rahul De
 
 Distributed under the MIT License. See LICENSE.