ci(workflow): add GitHub Actions workflow for merging develop into ma…

…in on tag creation

Introduce a new GitHub Actions workflow to automate the merging of the develop branch into the main branch whenever a new tag is pushed. This ensures that the main branch is always up-to-date with the latest changes from develop when a release is tagged.

docs: add CODEOWNERS file and update README with usage instructions

Create a CODEOWNERS file to specify that all code is currently owned by @mauvehed, ensuring clear ownership and responsibility for code changes. Update the README to include detailed usage instructions for both development and accessing the website, providing users and developers with clear guidance on how to interact with the project. Additionally, acknowledge inspiration from Zate's project, giving credit and context to the project's development.

docs(DEVELOPERS.md): clarify branch creation instructions

Add clarification to the branch creation instructions in the DEVELOPERS.md file, specifying that creating and switching to a develop branch is a one-time setup step. This helps developers understand the process more clearly and avoid unnecessary repetition.

.github/workflows/merge-develop-to-main.yml

@@ -0,0 +1,37 @@
+name: Tag Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  merge-develop-to-main:
+    name: Merge Develop into Main
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+        with:
+          # Fetch all history for accurate branch merging
+          fetch-depth: 0
+
+      - name: Configure Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Check out Develop Branch
+        run: git checkout develop
+
+      - name: Merge Develop into Main
+        run: |
+          git checkout main
+          git merge --no-ff develop -m "Merge branch 'develop' into 'main' on tag creation"
+
+      - name: Push to Main Branch
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          git push origin main

CODEOWNERS

@@ -0,0 +1,3 @@
+# All code currently owned by mauvehed
+
+*     @mauvehed

README.md

@@ -31,6 +31,36 @@
 
 This repository is a continuation of and extension to my existing [yourip](https://github.com/mauvehed/yourip) repository which was written in python and flask. I seek to eventually meet feature parity as I rewrite the application in javascript and vue in this repository.
 
+## Usage
+
+### Development
+
+Please see [Developers](docs/DEVELOPERS.md) for how to setup a dev environment
+
+### Using the website
+
+The current deployment of this tool is hosted and available to all online. You will have a couple choices for how you access
+the website and what format your ask for the IP address to be returned in.
+
+1. Point your browser to the official app URL at [https://yourip.app](https://yourip.app)
+2. Use your favorite command line web tool (e.g. curl, wget) to access one of the two endpoints (raw or json)
+
+   ```sh
+   $ curl -L yourIP.app/json
+   {
+     "ip": "123.45.6.78"
+   }
+   ```
+
+   ```sh
+   $ curl -L yourIP.app/raw
+   123.45.6.78
+   ```
+
+## Acknowledgements
+
+> Long desired to build, but for sure inspired by Zate's [https://urip.fyi](https://urip.fyi) web [project](https://github.com/Zate/urip.fyi) in Go
+
 ## Stats
 
 ![Alt](https://repobeats.axiom.co/api/embed/51a6836661e51cd2af55de642d907d4b57abef75.svg "Repobeats analytics image")

docs/DEVELOPERS.md

@@ -78,7 +78,7 @@ Check out the [deployment documentation](https://nuxt.com/docs/getting-started/d
 
 We use a simple variation of Git and GitHub Flow for branch control.
 
-### Create and switch to a develop branch
+### Create and switch to a develop branch (one-time)
 
 ```bash
 git checkout -b develop