Merge pull request #7 from madflojo/ci

chore: cleaning up docs and ci

.github/workflows/golangci-lint.yml

@@ -1,29 +1,29 @@
-name: golangci-lint
+name: lint
 on:
   push:
     tags:
       - v*
     branches:
-      - master
+      - actions
       - main
   pull_request:
 jobs:
   golangci:
-    name: lint
+    name: golangci
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v2
         with:
           # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
-          version: v1.29
+          version: latest
 
           # Optional: working directory, useful for monorepos
           # working-directory: somedir
 
           # Optional: golangci-lint command line arguments.
-          # args: --issues-exit-code=0
+          args: -E misspell -E revive -E errname -E gofmt
 
           # Optional: show only new issues if it's a pull request. The default value is `false`.
           # only-new-issues: true

.github/workflows/tests.yml

@@ -5,17 +5,32 @@ on:
     tags:
       - v*
     branches:
-      - master
+      - actions
       - main
   pull_request:
+
 jobs:
+
   tests:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
+
     - name: Set up Go
       uses: actions/setup-go@v2
       with:
-        go-version: '1.16'
-    - name: Execute Tests
-      run: make tests
+        go-version: 1.16
+
+    - name: Install cover
+      run: go get golang.org/x/tools/cmd/cover
+
+    - name: Install goveralls
+      run: go get -u github.com/mattn/goveralls
+
+    - name: Test
+      run: go test --race -v -covermode=atomic -coverprofile=coverage.out ./...
+
+    - name: Update Coveralls
+      env:
+        COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: goveralls -coverprofile=coverage.out -service=github

Makefile

@@ -12,7 +12,7 @@
 
 tests:
 	@echo "Running Tests with Coverage Report"
-	go test -v -covermode=count -coverprofile=coverage.out ./...
+	go test -v -covermode=atomic -race -coverprofile=coverage.out ./...
 	go tool cover -html=./coverage.out -o ./coverage.html
 
 benchmarks:

README.md

@@ -24,7 +24,7 @@ func main() {
 	msg := []byte("This is a message")
 
 	// Encoding Example
-	mli, err := simplemli.Encode(simplemli.2I, len(msg))
+	mli, err := simplemli.Encode(simplemli.MLI2I, len(msg))
 	if err != nil {
 		// Do something
 	}
@@ -44,7 +44,7 @@ func main() {
 	}
 
 	// Decoding Example
-	length, err := simplemli.Decode(simplemli.2I, &b)
+	length, err := simplemli.Decode(simplemli.MLI2I, &b)
 	if err != nil {
 		// Do something
 	}

mli.go

@@ -31,7 +31,7 @@ Usage:
 		msg := []byte("This is a message")
 
 		// Encoding Example
-		mli, err := simplemli.Encode(simplemli.2I, len(msg))
+		mli, err := simplemli.Encode(simplemli.MLI2I, len(msg))
 		if err != nil {
 			// Do something
 		}
@@ -51,7 +51,7 @@ Usage:
 		}
 
 		// Decoding Example
-		length, err := simplemli.Decode(simplemli.2I, &b)
+		length, err := simplemli.Decode(simplemli.MLI2I, &b)
 		if err != nil {
 			// Do something
 		}