Add a readme

Author: aclisp

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 aclisp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

readme.md

@@ -0,0 +1,19 @@
+# Go zero side
+
+Go-zero-side is a project to complement go-zero. It provides *more practical engineering tools* which work seamlessly with go-zero.
+
+The packages are:
+
+* `goschedule` A distributed cron job scheduler. It has a simple design to prevent multiple nodes from running the same job without using distributed locks.
+
+* `logz` An xorm logger implement to show SQL by integrating with go-zero logging facility. It also outputs trace-id for SQL logs.
+
+* `xormcache` *Deprecated.* An xorm cache implement using redis as the storage. It is deprecated because a remote cache is not so efficient as xorm's build-in local cache such as memory or leveldb.
+
+* `session` A HTTP session middleware, based on gorilla/sessions but far better than that.
+
+* `router` A customied go-zero/rest/httpx.Router. Currently it creates a fileServingRouter which handles HTTP caching correctly.
+
+* `embedx` handles go template files embedding as well as static files embedding.
+
+* `delayq` defines a general purpose Message struct as the protocol of zeromicro/go-queue/dq. It also propagates trace-id to the queue consumer.