Publishing Packages
This content is for v0.2.1. Switch to the latest version for up-to-date documentation.
RayQuiro packages are natively distributed through Git repositories and indexed by the official RayQuiro Registry (rq.raytolfas.cc).
1. Direct Distribution via GitHub
Section titled “1. Direct Distribution via GitHub”Any public GitHub repository containing an rqio.json can be installed immediately by any RayQuiro developer worldwide.
Step 1: Initialize Git and Push
Section titled “Step 1: Initialize Git and Push”cd my-mathgit initgit add .git commit -m "feat: initial release"git remote add origin https://github.com/username/my-math.gitgit branch -M maingit push -u origin mainStep 2: Tag a Release
Section titled “Step 2: Tag a Release”RayQuiro’s package manager resolves versions using Git tags. Tag your commit with the matching version from rqio.json:
git tag v1.0.0git push origin v1.0.0Step 3: Users Install Directly
Section titled “Step 3: Users Install Directly”Users can now install your package globally or per-project:
# Global installation:rqio add username/my-math
# Local project installation:rqio add username/my-math --local2. Submitting to the Official Registry
Section titled “2. Submitting to the Official Registry”Packages in the official registry can be installed using short names: rqio add my-math.
Submission Requirements
Section titled “Submission Requirements”- Manifest: Complete
rqio.jsonwith required keys:name,version,description,entry,license. - Documentation: Informative
README.mdwith installation and API usage examples. - Tags: At least one Git tag matching the manifest version (e.g.
v1.0.0). - License: Recognized open-source license.
Submission Steps
Section titled “Submission Steps”- Visit the registry repository:
https://github.com/Raytolfas/Assets. - Open a Pull Request adding your package to
RayQuiro/frameworks.json:{"name": "my-math","repo": "https://github.com/username/my-math","description": "Essential mathematical algorithms and vector utilities","category": "math"} - Once the automated validation CI passes and the PR is merged, your package is indexed on
rq.raytolfas.cc.
3. Releasing Updates
Section titled “3. Releasing Updates”When updating your package:
- Update
"version"inrqio.json(e.g."1.1.0"). - Commit and push:
Terminal window git commit -am "release: v1.1.0"git tag v1.1.0git push origin main --tags - Consumers update their installed dependencies with:
Terminal window rqio install