Merge pull request #77 from shoriwe/dev

Dev

.github/workflows/release.yml

@@ -2,7 +2,7 @@ name: Release
 
 on:
   push:
-    branches: ["master"]
+    branches: ["main"]
 
 jobs:
   coverage:

.github/workflows/version.yml

@@ -18,11 +18,11 @@ jobs:
           cache: "npm"
       - name: Git Identity
         run: |
-          git checkout main
+          git checkout dev
           git fetch --all --tags
           git config --global user.email "[email protected]"
           git config --global user.name "Antonio Donis"
       - name: Changelog
         run: 'npx standard-version --message "[ci skip] chore(release): %s"'
       - name: Push changes
-        run: git push --follow-tags --force origin main
+        run: git push --follow-tags --force origin dev

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### 4.1.1 (2023-06-12)
+
+
+### Bug Fixes
+
+* push to dev ([08a0196](https://github.com/shoriwe/fullproxy/commit/08a019659ab9473425977243a17b2772d3d6e56d))
+
 ## [4.1.0](https://github.com/shoriwe/fullproxy/compare/v3.2.0...v4.1.0) (2023-06-12)
 
 

README.md

@@ -0,0 +1,63 @@
+# fullproxy
+
+[![Release](https://github.com/shoriwe/fullproxy/actions/workflows/release.yml/badge.svg)](https://github.com/shoriwe/fullproxy/actions/workflows/release.yml)
+[![Test](https://github.com/shoriwe/fullproxy/actions/workflows/test.yml/badge.svg)](https://github.com/shoriwe/fullproxy/actions/workflows/test.yml)
+[![Versioning](https://github.com/shoriwe/fullproxy/actions/workflows/version.yml/badge.svg)](https://github.com/shoriwe/fullproxy/actions/workflows/version.yml)
+[![codecov](https://codecov.io/gh/shoriwe/fullproxy/branch/master/graph/badge.svg?token=WQSZVR7YT7)](https://codecov.io/gh/shoriwe/fullproxy)
+![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/shoriwe/fullproxy)
+[![Go Report Card](https://goreportcard.com/badge/github.com/shoriwe/fullproxy/v4)](https://goreportcard.com/report/github.com/shoriwe/fullproxy/v4)
+
+<img src="logo/white_logo_color_background.jpg" alt="logo" style="zoom: 25%;" />
+
+## Installing
+
+### Pre-compiled binaries 
+
+You can find pre-compiled binaries in [release](releases/latest)
+
+### Go install
+
+Can compile from source with:
+
+```shell
+go install github.com/shoriwe/fullproxy/v4@latest
+```
+
+### Cloning repository
+
+- Clone repository
+
+```shell
+git clone https://github.com/shoriwe/fullproxy
+```
+
+- Build
+
+```shell
+cd fullproxy && go build .
+```
+
+## Preview
+
+### Compose
+
+See [Compose](docs/Compose.md) for more information about **compose contracts**.
+
+```shell
+fullproxy compose ./fullproxy-compose.yaml
+```
+
+## Documentation
+
+| File                                                     | Description                                       |
+| -------------------------------------------------------- | ------------------------------------------------- |
+| [Circuits](docs/Circuits.md)                             | Documentation about how circuits work             |
+| [CLI](docs/CLI.md)                                       | Documentation of the CLI tool                     |
+| [Compose](docs/Compose.md)                               | Documentation about the **compose** specification |
+| [Continuous integration](docs/Continuous%20integration.md) | Documentation of the CI                           |
+
+## Coverage
+
+| [![codecov](https://codecov.io/gh/shoriwe/fullproxy/branch/master/graphs/sunburst.svg?token=WQSZVR7YT7)](https://github.com/shoriwe/fullproxy) | [![codecov](https://codecov.io/gh/shoriwe/fullproxy/branch/master/graphs/tree.svg?token=WQSZVR7YT7)](https://github.com/shoriwe/fullproxy) |
+| :----------------------------------------------------------: | :----------------------------------------------------------: |
+

package.json

@@ -3,5 +3,5 @@
 		"git-semver-tags": "^4.1.1",
 		"standard-version": "^9.5.0"
 	},
-	"version": "4.1.0"
+	"version": "4.1.1"
 }