Docs [pkg.go.dev] Improve Documentation (#5)

- [+] refactor(csr): remove function documentation from csr.go
- [+] docs(csr): add package-level documentation in docs.go with usage example

Author: H0llyW00dzZ

csr/csr.go

@@ -14,27 +14,6 @@ import (
 )
 
 // GenerateCSRAndPrivateKey generates a Certificate Signing Request (CSR) and a private key.
-//
-// The function takes the following parameters:
-//   - commonName: The common name (domain name) for the certificate.
-//   - dnsNames: A slice of Subject Alternative Names (SANs) for the certificate.
-//
-// The function returns the following:
-//   - csrPEM: The generated CSR in PEM format.
-//   - privateKeyPEM: The generated private key in PEM format.
-//   - err: An error, if any occurred during the generation process.
-//
-// The function generates an ECDSA private key using the P-256 curve and creates a CSR template
-// with the provided common name and SANs. The CSR is signed using the private key and encoded
-// in PEM format. The private key is also encoded in PEM format.
-//
-// Example usage:
-//
-//	csrPEM, privateKeyPEM, err := GenerateCSRAndPrivateKey("example.com", []string{"www.example.com", "api.example.com"})
-//	if err != nil {
-//	    // Handle the error
-//	}
-//	// Use csrPEM and privateKeyPEM for further processing or saving to files
 func GenerateCSRAndPrivateKey(commonName string, dnsNames []string) (csrPEM, privateKeyPEM []byte, err error) {
 	// Generate a new ECDSA key pair using the P-256 curve
 	privateKey, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)

csr/docs.go

@@ -3,4 +3,41 @@
 // License: BSD 3-Clause License
 
 // Package csr provides functionality for generating Certificate Signing Requests (CSRs) and private keys.
+//
+// The package exports a single function, [GenerateCSRAndPrivateKey], which generates an ECDSA private key
+// using the P-256 curve and creates a CSR template with the provided common name and Subject Alternative
+// Names (SANs). The CSR is signed using the private key and encoded in PEM format. The private key is also
+// encoded in PEM format.
+//
+// # Usage
+//
+// The [GenerateCSRAndPrivateKey] function takes the following parameters:
+//   - commonName: The common name (domain name) for the certificate.
+//   - dnsNames: A slice of Subject Alternative Names (SANs) for the certificate.
+//
+// The function returns the following:
+//   - csrPEM: The generated CSR in PEM format.
+//   - privateKeyPEM: The generated private key in PEM format.
+//   - err: An error, if any occurred during the generation process.
+//
+// Example:
+//
+//	commonName := "example.com"
+//	dnsNames := []string{"www.example.com", "api.example.com"}
+//
+//	csrPEM, privateKeyPEM, err := csr.GenerateCSRAndPrivateKey(commonName, dnsNames)
+//	if err != nil {
+//	    log.Fatalf("Failed to generate CSR and private key: %v", err)
+//	}
+//
+//	// Save the CSR and private key to files
+//	err = os.WriteFile("example.com.csr.pem", csrPEM, 0644)
+//	if err != nil {
+//	    log.Fatalf("Failed to write CSR to file: %v", err)
+//	}
+//
+//	err = os.WriteFile("example.com.key.pem", privateKeyPEM, 0600)
+//	if err != nil {
+//	    log.Fatalf("Failed to write private key to file: %v", err)
+//	}
 package csr