update README.md

Author: wenlng

LICENSE

@@ -1,21 +1,13 @@
-MIT License
+Copyright (c) 2021 Awen <wengaolng@gmail.com>
 
-Copyright (c) 2024 Awen
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
-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:
+ http://www.apache.org/licenses/LICENSE-2.0
 
-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.
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

README.md

@@ -1,2 +1,104 @@
-# go-captcha-assets
-This is a Go Captcha assets
+# Captcha Assets
+Go Captcha presets some default embedded resources and stores them in the Go file format. In addition, you can also configure the CAPTCHA according to your own needs.
+
+## Install
+```shell
+$ go get -u github.com/wenlng/go-captcha-assets@latest
+```
+
+### Chinese Text Assets
+```go
+import "github.com/wenlng/go-captcha-assets/bindata/chars"
+
+func Demo() {
+ chars := chars.GetChineseChars()
+}
+```
+
+### Alpha Text Assets
+```go
+import "github.com/wenlng/go-captcha-assets/bindata/chars"
+
+func Demo() {
+ chars := chars.GetAlphaChars()
+}
+```
+
+### Font Assets
+```go
+import "github.com/wenlng/go-captcha-assets/resources/fonts/fzshengsksjw"
+import "github.com/wenlng/go-captcha-assets/resources/fonts/yrdzst"
+
+func Demo() {
+ fonts, err := fzshengsksjw.GetFont()
+ if err != nil {
+ log.Fatalln(err)
+ }
+ 
+ // OR
+ 
+ fonts, err := yrdzst.GetFont()
+ if err != nil {
+ log.Fatalln(err)
+ }
+}
+```
+
+### Image Assets
+```go
+import "github.com/wenlng/go-captcha-assets/resources/images"
+
+func Demo() {
+ imgs, err := images.GetImages()
+ if err != nil {
+ log.Fatalln(err)
+ }
+}
+```
+
+### Shape Assets
+```go
+import "github.com/wenlng/go-captcha-assets/resources/shapes"
+
+func Demo() {
+ shapeMaps, err := shapes.GetShapes()
+ if err != nil {
+ log.Fatalln(err)
+ }
+}
+```
+
+### Thumbnail Assets
+```go
+import "github.com/wenlng/go-captcha-assets/resources/thumb"
+
+func Demo() {
+ imgs, err := thumb.GetImages()
+ if err != nil {
+ log.Fatalln(err)
+ }
+}
+```
+
+### Tile Assets
+```go
+import "github.com/wenlng/go-captcha-assets/resources/tiles"
+
+func Demo() {
+ graphs, err := tiles.GetTiles()
+ if err != nil {
+ log.Fatalln(err)
+ }
+ 
+ // slide
+ var newGraphs = make([]*slide.GraphImage, 0, len(graphs))
+ for i := 0; i < len(graphs); i++ {
+ graph := graphs[i]
+ newGraphs = append(newGraphs, &slide.GraphImage{
+ OverlayImage: graph.OverlayImage,
+ MaskImage: graph.MaskImage,
+ ShadowImage: graph.ShadowImage,
+ })
+ }
+}
+```