From d15cb5986aaada3e2e2834afe857942b5469d6aa Mon Sep 17 00:00:00 2001 From: Exelo Date: Sat, 10 Jan 2026 18:42:06 +0100 Subject: [PATCH] docs: fix readme badges --- .github/workflows/push-docs.yml | 2 +- README.md | 23 +++-- packages/asset-manager/README.md | 24 +++--- packages/common/README.md | 24 +++--- packages/config/README.md | 24 +++--- packages/core/README.md | 24 +++--- packages/ecs-client/README.md | 24 +++--- packages/ecs-lib/README.md | 24 +++--- packages/ecs-server/README.md | 24 +++--- packages/graphics-2d/README.md | 24 +++--- packages/input/README.md | 24 +++--- packages/music/README.md | 24 +++--- packages/network-client/README.md | 24 +++--- packages/network-server/README.md | 24 +++--- packages/sound/README.md | 24 +++--- releases/v0.0.1.md | 134 ------------------------------ utils/actions/README.md | 24 +++--- utils/eslint-config/README.md | 24 +++--- utils/prettier-config/README.md | 24 +++--- 19 files changed, 220 insertions(+), 323 deletions(-) delete mode 100644 releases/v0.0.1.md diff --git a/.github/workflows/push-docs.yml b/.github/workflows/push-docs.yml index 1493b04..51375db 100644 --- a/.github/workflows/push-docs.yml +++ b/.github/workflows/push-docs.yml @@ -1,4 +1,4 @@ -name: synchronize-docs +name: Synchronize Docs on: push: diff --git a/README.md b/README.md index 4aab744..38e317f 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,17 @@
-
-

- NanoForge -

-
-

- Tests status - Last commit. - contributors -

+
+

+ NanoForge +

+
+

+ Tests status + Documentation status + Last commit + Contributors +

-[![Nanoforge Documentation](https://github.com/NanoForge-dev/docs/actions/workflows/deploy.yml/badge.svg)](https://github.com/NanoForge-dev/docs/actions/workflows/deploy.yml) - ## About This repository contains multiple packages with separate [releases][github-releases]. Nanoforge is a powerful game engine for web browser. diff --git a/packages/asset-manager/README.md b/packages/asset-manager/README.md index 1207edf..c2699a0 100644 --- a/packages/asset-manager/README.md +++ b/packages/asset-manager/README.md @@ -1,15 +1,17 @@
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit. -

+
+

+ NanoForge +

+
+

+ npm version + npm downloads + Tests status + Documentation status + Last commit + Contributors +

## About diff --git a/packages/common/README.md b/packages/common/README.md index fe0087e..905ed56 100644 --- a/packages/common/README.md +++ b/packages/common/README.md @@ -1,15 +1,17 @@
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit. -

+
+

+ NanoForge +

+
+

+ npm version + npm downloads + Tests status + Documentation status + Last commit + Contributors +

## About diff --git a/packages/config/README.md b/packages/config/README.md index 99fd090..0ee4bd7 100644 --- a/packages/config/README.md +++ b/packages/config/README.md @@ -1,15 +1,17 @@
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit. -

+
+

+ NanoForge +

+
+

+ npm version + npm downloads + Tests status + Documentation status + Last commit + Contributors +

## About diff --git a/packages/core/README.md b/packages/core/README.md index 0e40709..f114fe2 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -1,15 +1,17 @@
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit. -

+
+

+ NanoForge +

+
+

+ npm version + npm downloads + Tests status + Documentation status + Last commit + Contributors +

## About diff --git a/packages/ecs-client/README.md b/packages/ecs-client/README.md index 7065f4d..f5b4078 100644 --- a/packages/ecs-client/README.md +++ b/packages/ecs-client/README.md @@ -1,15 +1,17 @@
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit. -

+
+

+ NanoForge +

+
+

+ npm version + npm downloads + Tests status + Documentation status + Last commit + Contributors +

## About diff --git a/packages/ecs-lib/README.md b/packages/ecs-lib/README.md index 9c2309c..aeddb97 100644 --- a/packages/ecs-lib/README.md +++ b/packages/ecs-lib/README.md @@ -1,15 +1,17 @@
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit. -

+
+

+ NanoForge +

+
+

+ npm version + npm downloads + Tests status + Documentation status + Last commit + Contributors +

## About diff --git a/packages/ecs-server/README.md b/packages/ecs-server/README.md index d5724bd..2852701 100644 --- a/packages/ecs-server/README.md +++ b/packages/ecs-server/README.md @@ -1,15 +1,17 @@
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit. -

+
+

+ NanoForge +

+
+

+ npm version + npm downloads + Tests status + Documentation status + Last commit + Contributors +

## About diff --git a/packages/graphics-2d/README.md b/packages/graphics-2d/README.md index c72628c..360fffe 100644 --- a/packages/graphics-2d/README.md +++ b/packages/graphics-2d/README.md @@ -1,15 +1,17 @@
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit. -

+
+

+ NanoForge +

+
+

+ npm version + npm downloads + Tests status + Documentation status + Last commit + Contributors +

## About diff --git a/packages/input/README.md b/packages/input/README.md index acf5a7b..7b5f237 100644 --- a/packages/input/README.md +++ b/packages/input/README.md @@ -1,15 +1,17 @@
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit. -

+
+

+ NanoForge +

+
+

+ npm version + npm downloads + Tests status + Documentation status + Last commit + Contributors +

## About diff --git a/packages/music/README.md b/packages/music/README.md index a086872..75c050d 100644 --- a/packages/music/README.md +++ b/packages/music/README.md @@ -1,15 +1,17 @@
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit. -

+
+

+ NanoForge +

+
+

+ npm version + npm downloads + Tests status + Documentation status + Last commit + Contributors +

## About diff --git a/packages/network-client/README.md b/packages/network-client/README.md index cbcf65f..0a1bf1f 100644 --- a/packages/network-client/README.md +++ b/packages/network-client/README.md @@ -1,15 +1,17 @@
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit. -

+
+

+ NanoForge +

+
+

+ npm version + npm downloads + Tests status + Documentation status + Last commit + Contributors +

## About diff --git a/packages/network-server/README.md b/packages/network-server/README.md index 0275e16..13c0b95 100644 --- a/packages/network-server/README.md +++ b/packages/network-server/README.md @@ -1,15 +1,17 @@
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit. -

+
+

+ NanoForge +

+
+

+ npm version + npm downloads + Tests status + Documentation status + Last commit + Contributors +

## About diff --git a/packages/sound/README.md b/packages/sound/README.md index bca6116..2f2ab56 100644 --- a/packages/sound/README.md +++ b/packages/sound/README.md @@ -1,15 +1,17 @@
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit. -

+
+

+ NanoForge +

+
+

+ npm version + npm downloads + Tests status + Documentation status + Last commit + Contributors +

## About diff --git a/releases/v0.0.1.md b/releases/v0.0.1.md deleted file mode 100644 index 9197d38..0000000 --- a/releases/v0.0.1.md +++ /dev/null @@ -1,134 +0,0 @@ -## [unreleased] - -### Bug Fixes - -- *(ecs)* Change jest workflow -- *(ecs)* Constructor are now binded -- *(ecs/sparse array)* No discard on const methods -- *(ecs/sparseArray)* Fix missing erase definition -- *(ecs)* Fix jest workflow and tests compile -- *(ecs)* Add type name verification for vars -- *(ecs)* Change type handling on lib ecs -- *(ecs)* Fix tests -- *(common)* Init lib order -- *(common)* Change is running -- *(graphics)* Fix display -- *(graphics)* Fix tests -- *(graphics)* Game loop -- *(game)* Delete bun.lock -- *(pong)* Delete custom framerate -- *(ecs)* Rename createEntity to spawnEnity -- *(exceptions)* Bad naming -- Change exception handling -- *(common)* Update exception imports and adjust formatting in abstract class -- *(graphics-2d, ecs)* Update type handling in vertex buffer and library init test -- *(music)* Versions issue - -### Features - -- Initial commit -- *(ecs/compilation)* Add basic makefile -- Add wasm compilation to package.json -- *(ecs/compilation)* Add wasm object creation -- *(ecs/wasm)* Emsdk installation script in Readme.md -- *(ecs/wasm)* Add basic test templated class -- *(ecs/wasm)* Emsdk installation script in Readme.md -- *(ecs)* Setup basic sparse array boiler plate code. -- *(ecs)* Add type generation in makefile -- *(ecs/sparseArray)* Add more functions to the sparse array -- *(ecs/sparseArray)* Add more functions to the sparse array -- Custom header -- Add core and common -- Add asset manager default in core -- *(ecs/registry)* Base regitry and simple tests: -- *(ecs/registry)* Systems handling and testing -- *(asset-manager)* Add base library -- *(asset-manager)* Add asset manager -- *(asset-manager)* Add tests -- *(ecs)* Modify ts rule to get types -- *(graphics-2d)* Add base library -- *(asset-manager)* Add wgsl handling -- *(asset-manager)* Add file return -- *(common)* Add templates to each get library functions -- *(graphics)* Add base component and circle component -- *(ecs/zipper)* Add indexed zipper and zipper with tests -- *(ecs)* Setup wasm to be loaded from path specified in ecs library -- *(ecs)* Add more methods to be exported by ecs library -- *(ecs/tsbindings)* Add the zipper functions to the library -- *(game)* Add template -- *(game)* Add graphics factory -- *(game)* Add width and height -- *(game)* Create pong example game -- *(template)* Add scripts to template -- *(example/pong)* Base velocity system clocked with a framerate limiter -- *(ecs)* Add type for components -- *(systems)* Add ts type for systems -- *(ecs)* Type getEntityComponent family of functions -- *(ecs/zipper)* Merge zipper in types -- *(graphics)* Add rectangle -- *(input)* Add input library -- *(core)* Add tickrate and fix runner -- *(game)* Create pong bounce system -- *(game)* Create pong players with background -- *(game)* Add inputs in pong -- *(graphics)* Add dynamic size handle of canvas -- *(common)* Add dependencies handler -- Add dependencies to current libs -- Add dependencies handling -- *(core)* Add default libraries to constructor -- *(sound)* Init basic sound library -- *(sound)* Add sound playing -- *(sound)* Add basic sound playing to example -- *(app)* Add the ability to mute and unmute sounds -- *(core)* Enhance type safety and execution context handling -- *(config)* Add initial configuration for libraries -- *(common, core, config)* Introduce configuration registry and validation system -- *(core)* Add `class-transformer` and `class-validator` dependencies for validation utilities -- *(music)* Init basic music library -- *(music)* Finish music library and add an interface for mutable libraries -- *(ci)* Add build step to GitHub Actions tests workflow -- *(example)* Update `pong` game mechanics and graphics integration -- *(systems)* Start adding context to systems -- *(ecs)* Add ecs context to the systems - -### Miscellaneous Tasks - -- Fix idea -- *(ecs)* Change idea name -- Add idea to common and core -- Add current state of graphics library -- Remove bun lock that was breaking unit tests -- *(husky)* Update pre-push and commit-msg scripts for pnpm compatibility -- *(config)* Update nx and gitignore configurations, adjust prettierignore rules -- *(example)* Update `pong` example to use workspace dependencies and refine configurations -- *(husky)* Simplify pre-push script by adjusting pnpm command -- Migrate to shared ESLint and Prettier configurations, remove package-specific configs -- Remove `pnpm-lock.yaml` to decouple dependency locking from the workspace configuration -- Migrate packages to shared ESLint and Prettier configs -- Remove unnecessary `@types/node` and `typescript` dependencies from `packages/input` -- Update Jest configs and refine tsconfig paths across packages -- *(example/pong)* Update dependencies, and migrate to shared ESLint & Prettier configs -- *(example/template)* Update dependency locking to workspace resolution -- Prepare first release - -### Refactor - -- *(graphics-2d)* Remove custom rendering core and replace with `Konva` - -### Testing - -- *(ecs/sparseArray)* Add unit tests for sparse array -- *(libs)* Include ConfigRegistry in library initialization test - -### Build - -- *(ecs)* Add standalone build and html and js build -- Update dependencies -- Upgrade dependencies and engines to latest versions - -### Ci - -- Setup tests ci -- Add linting to ci -- Branch name was on master isntead of main -- *(release)* Create a release workflow diff --git a/utils/actions/README.md b/utils/actions/README.md index 975bcd7..1111cef 100644 --- a/utils/actions/README.md +++ b/utils/actions/README.md @@ -1,15 +1,17 @@
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit. -

+
+

+ NanoForge +

+
+

+ npm version + npm downloads + Tests status + Documentation status + Last commit + Contributors +

## About diff --git a/utils/eslint-config/README.md b/utils/eslint-config/README.md index 38951c2..7b2bf62 100644 --- a/utils/eslint-config/README.md +++ b/utils/eslint-config/README.md @@ -1,15 +1,17 @@
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit. -

+
+

+ NanoForge +

+
+

+ npm version + npm downloads + Tests status + Documentation status + Last commit + Contributors +

## About diff --git a/utils/prettier-config/README.md b/utils/prettier-config/README.md index 9ee47f7..e239aac 100644 --- a/utils/prettier-config/README.md +++ b/utils/prettier-config/README.md @@ -1,15 +1,17 @@
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit. -

+
+

+ NanoForge +

+
+

+ npm version + npm downloads + Tests status + Documentation status + Last commit + Contributors +

## About