Update project documentation.

Author: v0ctor

CONTRIBUTING.md renamed to contributing.md

@@ -8,13 +8,13 @@ This project follows [Semantic Versioning](https://semver.org). The version of t
 
 ## Installation
 
-Use `go get` to add the library as a project's dependency. Do not forget to run `go mod init` first if necessary.
+Use `go get` to add the library as a dependency to your project. Do not forget to run `go mod init` first if necessary.
 
 ```shell
 go get github.com/netbox-community/go-netbox/v3
 
 # Or install a specific version
-go get github.com/netbox-community/go-netbox/v3@v3.4.5-1
+go get github.com/netbox-community/go-netbox/v3@v3.7.1-0
 ```
 
 **Note:** dependencies should be managed with [Go modules](https://go.dev/doc/modules/managing-dependencies).
@@ -23,102 +23,68 @@ go get github.com/netbox-community/go-netbox/v3@v3.4.5-1
 
 ### Instantiate the client
 
-The package has some convenience functions for creating clients with the most common configurations.
+The package has a constructor for creating a client providing a URL and an authentication token.
 
 ```golang
 package main
 
 import (
+	"context"
 	"log"
 
-	"github.com/netbox-community/go-netbox/v3/netbox"
+	"github.com/netbox-community/go-netbox/v3"
 )
 
 func main() {
-	c := netbox.NewNetboxAt("netbox.example.org:8000")
-    
-	// or:
-	// c := netbox.NewNetboxWithAPIKey("netbox.example.org:8000", "<api-token>")
+	ctx := context.Background()
 
-	log.Printf("%+v", c)
-}
-```
-
-In order to consume the Netbox API with HTTP over TLS, a transport must be created.
-
-```golang
-package main
-
-import (
-	"fmt"
-	"log"
-
-	transport "github.com/go-openapi/runtime/client"
-	"github.com/netbox-community/go-netbox/v3/netbox/client"
-)
-
-func main() {
-	t := transport.New("netbox.example.org", client.DefaultBasePath, []string{"https"})
-
-	t.DefaultAuthentication = transport.APIKeyAuth(
-		"Authorization",
-		"header",
-		fmt.Sprintf("Token %v", "<api-token>"),
-	)
-
-	c := client.New(t, nil)
+	c := netbox.NewAPIClientFor("https://demo.netbox.dev", "v3ry$3cr3t")
 
 	log.Printf("%+v", c)
 }
-```
-
-For more complex client configurations, see the documentation of _[github.com/go-openapi/runtime/client](https://pkg.go.dev/github.com/go-openapi/runtime/client)_, the library which in turn is used by the client.
 
-**Note:** setting the `DEBUG` environment variable will dump all requests to standard error output.
+```
 
 ### Use the client
 
 With the client already instantiated, it is possible to consume any API feature.
 
-For example, to list the first 100 active virtual machines:
+For example, to list the first 10 active virtual machines:
 
 ```golang
 package main
 
 import (
+	"context"
 	"log"
 
-	"github.com/netbox-community/go-netbox/v3/netbox"
-	"github.com/netbox-community/go-netbox/v3/netbox/client/virtualization"
+	"github.com/netbox-community/go-netbox/v3"
 )
 
-var status = "active"
-var pageLimit = int64(100)
-
 func main() {
-	c := netbox.NewNetboxWithAPIKey("netbox.example.org", "<api-token>")
+	ctx := context.Background()
 
-	req := virtualization.
-		NewVirtualizationVirtualMachinesListParams().
-		WithStatus(&status).
-		WithLimit(&pageLimit)
+	c := netbox.NewAPIClientFor("https://demo.netbox.dev", "v3ry$3cr3t")
 
-	// additional `authInfo` is `nil` because the API token has already been specified in the client 
-	res, err := w.netbox.Virtualization.VirtualizationVirtualMachinesList(req, nil)
+	res, _, err := c.VirtualizationAPI.
+		VirtualizationVirtualMachinesList(ctx).
+		Status([]string{"active"}).
+		Limit(10).
+		Execute()
 
 	if err != nil {
 		log.Fatal(err)
 	}
 
-	log.Printf("%+v", res.Payload.Results)
+	log.Printf("%v", res.Results)
 }
 ```
 
-See [reference](https://pkg.go.dev/github.com/netbox-community/go-netbox) for more information on all possible usages.
+See [docs](docs) or [reference](https://pkg.go.dev/github.com/netbox-community/go-netbox) for more information on all possible usages.
 
 ## Development
 
-The project comes with a containerized development environment that can be used from any platform. It is only required to have [Git](https://git-scm.com) and [Docker Desktop](https://www.docker.com/products/docker-desktop/) (or, separately, [Docker](https://docs.docker.com/engine/install) and [Docker Compose](https://docs.docker.com/compose/install/)) installed on the machine.
+The project comes with a containerized development environment that may be used from any platform. It is only required to have [Git](https://git-scm.com) and [Docker Desktop](https://www.docker.com/products/docker-desktop/) (or, separately, [Docker](https://docs.docker.com/engine/install) and [Docker Compose](https://docs.docker.com/compose/install/)) installed on the machine.
 
 To start the development environment, run the following command.
 
@@ -140,12 +106,12 @@ make down
 
 ### Considerations
 
-The library is almost entirely generated from the Netbox [OpenAPI](https://www.openapis.org/) specification using _[go-swagger](https://github.com/go-swagger/go-swagger)_. Therefore, files under directories `netbox/client` and `netbox/models` should not be directly modified, as they will be overwritten in the next regeneration (see next section).
+The library is entirely generated from the Netbox [OpenAPI](https://www.openapis.org/) specification using _[openapi-generator](https://github.com/OpenAPITools/openapi-generator)_. Therefore, files listed [here](.openapi-generator/files) should not be directly modified, as they will be overwritten in the next regeneration (see next section).
 
-To fix issues in generated code, there are two options:
+In order to fix a bug in the generated code, the corresponding error in the OpenAPI spec must be fixed. To do so, the following steps may be followed:
 
-- Change the OpenAPI spec with pre-generation hooks (see [`scripts/pre-generation`](scripts/pre-generation)).
-- If the above is not possible, change the generated code with post-generation hooks (see [`scripts/post-generation`](scripts/post-generation)).
+1. Optional. Patch the OpenAPI spec in this repo by editing [this script](scripts/fix-spec.py), so that a corrected version can be published as soon as possible.
+2. Fix the OpenAPI spec in the [Netbox repository](https://github.com/netbox-community/netbox), either by reporting an issue or by creating a pull request.
 
 ### Regenerate the library