From ca9068491be30942d27dd0bdc926de646707c737 Mon Sep 17 00:00:00 2001 From: Marcos Huck Date: Tue, 30 Jan 2024 23:44:33 -0300 Subject: [PATCH] Add new version to readme and improve docs Signed-off-by: Marcos Huck --- README.md | 10 ++++++---- strings/ascii.go | 21 +++++++++++++++++++++ strings/camel_case.go | 21 +++++++++++++++++++++ strings/doc.go | 3 +++ strings/pascal_case.go | 26 ++++++++++++++++++++------ 5 files changed, 71 insertions(+), 10 deletions(-) create mode 100644 strings/doc.go diff --git a/README.md b/README.md index c1ef132..cbb995d 100644 --- a/README.md +++ b/README.md @@ -15,17 +15,19 @@ developers a clean and easy-to-use API to initialize, configure and extend web s - Configuration - Database - Repository -- HTTP servers -- gRPC servers -- Telemetry +- HTTP servers 🔜 +- gRPC servers 🔜 +- Telemetry 🔜 - Logging - Tracing - Monitoring +- Utilities + - String manipulation ## Getting started ```shell -go get github.com/gojaguar/jaguar@v0.5.0 +go get github.com/gojaguar/jaguar@v0.6.0 ``` ## Disclaimer diff --git a/strings/ascii.go b/strings/ascii.go index c78a392..f1eb60b 100644 --- a/strings/ascii.go +++ b/strings/ascii.go @@ -1,3 +1,24 @@ +// Copyright 2010 The Go Authors. All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// - Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// +// - Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// +// - Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// Original license: https://github.com/golang/protobuf/blob/master/LICENSE +// Original CamelCase func: https://github.com/golang/protobuf/blob/master/protoc-gen-go/generator/generator.go#L2648 + package strings // Is c an ASCII lower-case letter? diff --git a/strings/camel_case.go b/strings/camel_case.go index c8ccd0e..86a0dc5 100644 --- a/strings/camel_case.go +++ b/strings/camel_case.go @@ -1,3 +1,24 @@ +// Copyright 2010 The Go Authors. All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// - Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// +// - Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// +// - Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// Original license: https://github.com/golang/protobuf/blob/master/LICENSE +// Original CamelCase func: https://github.com/golang/protobuf/blob/master/protoc-gen-go/generator/generator.go#L2648 + package strings // CamelCase is a special case of PascalCase with the difference that diff --git a/strings/doc.go b/strings/doc.go new file mode 100644 index 0000000..deb03c0 --- /dev/null +++ b/strings/doc.go @@ -0,0 +1,3 @@ +// Package strings implements simple functions to manipulate UTF-8 encoded strings that are not included in the +// standard library package. +package strings diff --git a/strings/pascal_case.go b/strings/pascal_case.go index 6511954..690beeb 100644 --- a/strings/pascal_case.go +++ b/strings/pascal_case.go @@ -1,10 +1,24 @@ -// Copyright 2010 The Go Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. -// The original CamelCase was adapted to PascalCase. +// Copyright 2010 The Go Authors. All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// - Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// +// - Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// +// - Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// Original license: https://github.com/golang/protobuf/blob/master/LICENSE +// Original CamelCase func: https://github.com/golang/protobuf/blob/master/protoc-gen-go/generator/generator.go#L2648 -// Package strings implements simple functions to manipulate UTF-8 encoded strings that are not included in the -// standard library package. package strings // PascalCase returns the PascalCased name.