refactor

.github/workflows/golang.yaml

@@ -0,0 +1,23 @@
+name: Go package
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.19'
+
+      - name: Build
+        run: go build -v ./...
+
+      - name: Test
+        run: go test -v ./...

README.md

@@ -1,8 +1,39 @@
-# Time Provider
+# NTP Time Provider
 
-基于NTP的TimeProvider
+# 一、这是什么
+
+基于NTP的TimeProvider实现，Storage的具体实现可以引入这个库来实现GetTime方法，让分布式系统中的各个角色使用统一的NTP时间源。
+
+# 二、安装依赖
 
 ```bash
 go get -u github.com/storage-lock/go-ntp-time-provider
 ```
 
+# 三、API示例
+
+```go
+package main
+
+import (
+	"context"
+	"fmt"
+	"github.com/storage-lock/go-events"
+	ntp_time_provider "github.com/storage-lock/go-ntp-time-provider"
+)
+
+func main() {
+
+	event := events.NewEvent("test")
+	timeProvider := ntp_time_provider.NewNTPTimeProvider(event)
+	time, err := timeProvider.GetTime(context.Background())
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println(time)
+	// Output:
+	// 2023-08-07 01:36:18.29416265 +0800 CST m=-1.335806449
+
+}
+```
+

actions.go

@@ -1,4 +1,4 @@
-package storage
+package ntp_time_provider
 
 // time provider
 const (

default_ntp_server.go

@@ -1,4 +1,4 @@
-package storage
+package ntp_time_provider
 
 // DefaultNtpServers 默认的NTP服务器，使用者可以在系统初始化的覆盖掉这个变量来设置默认的NTP服务器
 var DefaultNtpServers = []string{

errors.go

@@ -1,4 +1,4 @@
-package storage
+package ntp_time_provider
 
 import "errors"
 

examples/main.go

@@ -0,0 +1,22 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"github.com/storage-lock/go-events"
+	ntp_time_provider "github.com/storage-lock/go-ntp-time-provider"
+)
+
+func main() {
+
+	event := events.NewEvent("test")
+	timeProvider := ntp_time_provider.NewNTPTimeProvider(event)
+	time, err := timeProvider.GetTime(context.Background())
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println(time)
+	// Output:
+	// 2023-08-07 01:36:18.29416265 +0800 CST m=-1.335806449
+
+}

ntp_time_provider.go

@@ -1,4 +1,4 @@
-package storage
+package ntp_time_provider
 
 import (
 	"context"

ntp_time_provider_test.go

@@ -1,4 +1,4 @@
-package storage
+package ntp_time_provider
 
 import (
 	"context"