docs: Added a fairly substantional readme file.

This readme file documents how to use this repository as a template in a productive manner.
Merge pull request 'chore(example_bin): release v0.1.1' (#5 ) from release-plz-2026-09-11T14-51-37Z into melfely/release-plz
2026-09-11 11:20:33 -05:00 · 2026-09-11 11:20:33 -05:00 · 2026-09-11 11:20:33 -05:00 · 2026-09-11 11:20:33 -05:00 · 2026-09-11 11:20:33 -05:00 · 2026-09-11 02:09:34 +00:00
2 changed files with 4 additions and 2 deletions
@@ -2,7 +2,9 @@ name: Release-plz

 on:
  push:
-   branches: [main, master]
+# Comment out branch restrictions until we are closer to done
+#    branches:
+#      - [main, master]

 jobs:

@@ -4,4 +4,4 @@ version = "0.1.1"
 edition = "2024"

 [dependencies]
-example_lib = { version = "0.1.0", path = "../example_lib", registry = "gitea" }
+example_lib = { path = "../example_lib" }
Author	SHA1	Message	Date
melfely	72575b2d24	docs: Added a fairly substantional readme file. Release-plz / Release-plz PR (push) Canceled after 14s Details Release-plz / Release-plz release (push) Canceled after 16s Details This readme file documents how to use this repository as a template in a productive manner.	2026-09-11 11:20:33 -05:00
melfely	9e2ece840c	Merge pull request 'chore(example_bin): release v0.1.1' (#5 ) from release-plz-2026-09-11T14-51-37Z into melfely/release-plz Reviewed-on: #5 fix(bin): Added version for lib requirement ci: added release-plz.toml file fix: Add registry force in the dependencies of cargo section ci: Changed release CI to only Run on the master/main branches	2026-09-11 11:20:33 -05:00
melfely	214e8f7f04	ci: Revert previous. Fixed "secret." to "secrets." for git credentials	2026-09-11 11:20:33 -05:00
ci-bot	3749f6b9ad	chore(example_bin): release v0.1.1 Signed-off-by: ci-bot <bot@email.melfely.com>	2026-09-11 11:20:33 -05:00
melfely	61b4892417	Merge pull request 'chore(example_lib): release v0.1.1' (#4 ) from release-plz-2026-09-11T01-35-29Z into melfely/release-plz Reviewed-on: #4 feat: bin example now references the local example_lib ci: Changed from direct secret sub to env variables	2026-09-11 11:20:33 -05:00
melfely	d2400ee8bf	Merge branch 'melfely/release-plz' into release-plz-2026-09-11T01-35-29Z Lint & Build / Linting (pull_request) Successful in 2m18s Details Release-plz / Release-plz PR (push) Successful in 2m21s Details Release-plz / Release-plz release (push) Successful in 2m26s Details Lint & Build / Build (pull_request) Successful in 58s Details Lint & Build / Test (pull_request) Successful in 1m29s Details Lint & Build / Cross-Build-Windows (pull_request) Successful in 2m2s Details Lint & Build / Cross-Build-Linux (pull_request) Successful in 2m15s Details Lint & Build / Cross-Build-MacOS (pull_request) Successful in 2m33s Details	2026-09-11 02:09:34 +00:00
melfely	782c9166c2	ci: removes the uneeded step "install git" Release-plz / Release-plz PR (push) Successful in 1m28s Details Release-plz / Release-plz release (push) Successful in 1m32s Details	2026-09-10 21:02:58 -05:00
melfely	c365c2b9e5	ci: attempting to use manual git credential config Release-plz / Release-plz PR (push) Failing after 0s Details Release-plz / Release-plz release (push) Successful in 1m31s Details	2026-09-10 20:58:06 -05:00
melfely	135ea657fa	ci: added repository url replacement Release-plz / Release-plz release (push) Successful in 3m21s Details Release-plz / Release-plz PR (push) Failing after 3m25s Details	2026-09-10 20:44:15 -05:00
melfely	ae39643568	chore(example_lib): release v0.1.1 Lint & Build / Linting (pull_request) Successful in 2m26s Details Release-plz / Release-plz release (push) Successful in 2m36s Details Release-plz / Release-plz PR (push) Successful in 2m39s Details Lint & Build / Build (pull_request) Successful in 1m20s Details Lint & Build / Test (pull_request) Successful in 2m32s Details Lint & Build / Cross-Build-Windows (pull_request) Successful in 12m28s Details Lint & Build / Cross-Build-Linux (pull_request) Successful in 12m49s Details Lint & Build / Cross-Build-MacOS (pull_request) Successful in 13m21s Details Signed-off-by: melfey <bug362@outlook.com>	2026-09-10 20:35:29 -05:00
melfely	bb37eb9d94	feat: added pub fn sub() Release-plz / Release-plz release (push) Successful in 1m27s Details Release-plz / Release-plz PR (push) Failing after 1m34s Details This takes in two u64, and returns the difference. TESTING WORKFLOWS	2026-09-10 20:18:36 -05:00
melfely	77cfc8bed9	ci: added git user and correct cargo repo token signature Release-plz / Release-plz release (push) Successful in 1m33s Details Release-plz / Release-plz PR (push) Successful in 1m34s Details	2026-09-10 20:12:55 -05:00
melfely	8abb2f210b	fix: wrong url in the config.toml cargo registry Release-plz / Release-plz PR (push) Failing after 1m28s Details Release-plz / Release-plz release (push) Failing after 1m33s Details	2026-09-10 20:05:24 -05:00
melfely	a70cbca5a9	ci: Change from release-plz action to cli Release-plz / Release-plz release (push) Failing after 1m47s Details Release-plz / Release-plz PR (push) Failing after 1m54s Details The action currently only supports github (I think) while the CLI tool claims to support gitea (the action also does...)	2026-09-10 20:00:06 -05:00
melfely	bbca93470c	ci: replaces v0.5 with v0.4 (this working is a hell of a stretch) Release-plz / Release-plz PR (push) Failing after 1m20s Details Release-plz / Release-plz release (push) Failing after 1m20s Details	2026-09-10 19:36:18 -05:00
melfely	a1aaf5cd7e	ci: Added gh tool install. Release-plz / Release-plz PR (push) Failing after 1m43s Details Release-plz / Release-plz release (push) Failing after 1m44s Details	2026-09-10 19:31:37 -05:00
melfely	b3d5f4ef18	ci: Removed Github token from the run. Release-plz / Release-plz release (push) Failing after 1m38s Details Release-plz / Release-plz PR (push) Failing after 1m40s Details	2026-09-10 18:54:03 -05:00
melfely	316a3c591d	ci: Added Release-Plz CI workflow. Release-plz / Release-plz release (push) Failing after 1m53s Details Release-plz / Release-plz PR (push) Failing after 1m55s Details	2026-09-10 18:47:25 -05:00