feat(centralnic reseller go-sdk): introducing CNR Go-SDK API Connector

.golangci.yml → .github/linters/.golangci.yml

@@ -5,8 +5,8 @@
 #########################
 #########################
 
-# https://raw.githubusercontent.com/super-linter/super-linter/main/.github/linters/.golangci.yml
-
+# configure golangci-lint
+# see https://github.com/golangci/golangci-lint/blob/master/.golangci.example.yml
 issues:
   exclude-rules:
     - path: _test\.go
@@ -22,13 +22,20 @@ linters:
     - goconst
     - goimports
     - gocritic
+    - govet
     - revive
-    - shadow # Added shadow linter
 linters-settings:
   errcheck:
-    # report about assignment of errors to blank identifier
+    # report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`;
     # default is false: such cases aren't reported by default.
     check-blank: true
+  govet:
+    enable:
+      # report about shadowed variables
+      - shadowing
   gocyclo:
     # minimal code complexity to report, 30 by default
-    min-complexity: 15
+    min-complexity: 20
+  maligned:
+    # print struct with more effective memory layout or not, false by default
+    suggest-new: true

README.md

@@ -7,13 +7,41 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 [![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/centralnicgroup-opensource/rtldev-middleware-go-sdk/blob/master/CONTRIBUTING.md)
 
-This module is a connector library for the insanely fast HEXONET Backend API. For further informations visit our [homepage](http://hexonet.net) and do not hesitate to [contact us](https://www.hexonet.net/contact).
+This module is a connector library for the insanely fast CentralNic Reseller Backend API. For further informations visit our [homepage](https://www.centralnicreseller.com) and do not hesitate to [contact us](https://www.centralnicreseller.com/contact).
+
+## Deprecation Notice: Hexonet Go SDK
+
+This SDK succeeds the deprecated Hexonet Go SDK. It is an enhanced version that builds upon the foundation laid by the Hexonet SDK, offering improved features and performance. Hexonet is migrating to CentralNic Reseller, ensuring continued support and development under the new branding.
 
 ## Resources
 
-- Documentation:
-  - [HEXONET](https://www.hexonet.support/hc/en-gb/articles/13651860201117-Self-Development-Kit-for-Go-Golang)
-- [Release Notes](https://github.com/centralnicgroup-opensource/rtldev-middleware-go-sdk/releases)
+- [Documentation](https://support.centralnicreseller.com/hc/en-gb/articles/5714403954333-Self-Development-Kit-for-Go-Golang)
+
+## Release Notes
+
+For detailed release notes, please visit the [Release Notes](https://github.com/centralnicgroup-opensource/rtldev-middleware-go-sdk/releases) page.
+
+## Running the Demo Application
+
+To run the demo application, follow these steps:
+
+1. **Set Your Credentials**: Ensure your credentials are available. You can either:
+  - Replace them directly in the application file.
+  - Set the environment variables `CNR_TEST_USER` and `CNR_TEST_PASSWORD` in your terminal.
+
+2. **Execute the Demo**: Once your credentials are set, run the following command in the terminal:
+
+   ```sh
+   npm run test-demo
+   ```
+
+3. **Update Demo Contents**: If you need to update the contents of the demo file, you can find it at:
+
+   ```plaintext
+   demo/demo.go
+   ```
+
+By following these steps, you can successfully run and update the demo application.
 
 ## Authors