docs: add badge row, CodeQL, CITATION.cff and llms.txt

.github/workflows/codeql.yml

@@ -0,0 +1,46 @@
+name: CodeQL
+
+on:
+  push:
+    branches: [develop]
+  pull_request:
+    branches: [develop]
+  schedule:
+    - cron: "23 3 * * 1"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  analyze:
+    name: Analyze ${{ matrix.language }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    permissions:
+      contents: read
+      security-events: write # Upload CodeQL results for this job only.
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [javascript-typescript, python, rust, actions]
+    steps:
+      - name: Check out source
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: Initialise CodeQL
+        uses: github/codeql-action/init@6f2ac81f5cd81fe351a197ba0b00d91d03cd2aee # v4
+        with:
+          languages: ${{ matrix.language }}
+          build-mode: none
+
+      - name: Perform CodeQL analysis
+        uses: github/codeql-action/analyze@6f2ac81f5cd81fe351a197ba0b00d91d03cd2aee # v4
+        with:
+          category: "/language:${{ matrix.language }}"

CITATION.cff

@@ -0,0 +1,23 @@
+cff-version: 1.2.0
+message: "If you use this work, cite it with this metadata and the release tag or commit you used."
+title: "RGG"
+type: software
+authors:
+  - name: "RTK AI Labs"
+  - name: "EquityBot"
+abstract: "A distribution of RTK: command output, compressed before your coding agent reads it."
+repository-code: "https://github.com/EquityBot/rgg"
+license-url: "https://github.com/EquityBot/rgg/blob/develop/LICENSE"
+keywords:
+  - claude-code
+  - cli
+  - developer-tools
+  - llm
+  - rust
+  - token-optimization
+references:
+  - type: software
+    title: "RTK"
+    authors:
+      - name: "RTK AI Labs"
+    repository-code: "https://github.com/rtk-ai/rtk"

README.md

@@ -9,7 +9,8 @@
 
 <div align="center">
 
-[![Code quality](https://img.shields.io/codacy/grade/68c5d91770634f3b86493583fd8eada6/develop?label=code%20quality&labelColor=000000&style=flat)](https://app.codacy.com/gh/ryanduguid/rtk/dashboard) [![licence: Apache-2.0 and BUSL-1.1](https://img.shields.io/badge/licence-Apache--2.0%20%2B%20BUSL--1.1-66023C?labelColor=000000&style=flat&color=66023C)](#licence) [![fork of: RTK](https://img.shields.io/badge/fork%20of-RTK-66023C?labelColor=000000&style=flat&color=66023C)](https://github.com/rtk-ai/rtk)
+[![CodeQL](https://img.shields.io/github/actions/workflow/status/EquityBot/rgg/codeql.yml?branch=develop&label=CodeQL&labelColor=000000&style=flat)](https://github.com/EquityBot/rgg/actions/workflows/codeql.yml) [![Codacy](https://img.shields.io/codacy/grade/68c5d91770634f3b86493583fd8eada6/develop?label=Codacy&labelColor=000000&style=flat)](https://app.codacy.com/gh/ryanduguid/rtk/dashboard)<br>
+[![rust: 1.91+](https://img.shields.io/badge/rust-1.91%2B-66023C?labelColor=000000&style=flat&color=66023C)](https://www.rust-lang.org/) [![licence: Apache-2.0 AND BUSL-1.1](https://img.shields.io/badge/licence-Apache--2.0%20AND%20BUSL--1.1-66023C?labelColor=000000&style=flat&color=66023C)](#licence) [![fork of: RTK](https://img.shields.io/badge/fork%20of-RTK-66023C?labelColor=000000&style=flat&color=66023C)](https://github.com/rtk-ai/rtk)
 
 [Install](#install) · [What RGG changes](#what-rgg-changes) · [Inherited from RTK](#inherited-from-rtk) · [Credits](#credits) · [Licence](#licence)
 

llms.txt

@@ -0,0 +1,36 @@
+# RGG
+
+> EquityBot's distribution of RTK, the Rust Token Killer: one Rust binary that filters and
+> compresses command output before it reaches a coding agent's context. It has no prebuilt
+> binaries and installs a binary named `rtk`, as upstream RTK does, so uninstall any other RTK copy first.
+
+Version `1.0.1+rgg`, built from source with
+`cargo install --git https://github.com/EquityBot/rgg rtk --locked`. Add
+`--no-default-features` for the Apache-2.0-only build without the compression engine.
+
+## Start
+
+- [README](https://github.com/EquityBot/rgg#readme): install, what RGG changes from RTK and the licence terms.
+- [Quick Start](https://github.com/EquityBot/rgg/blob/develop/docs/guide/getting-started/quick-start.md): set up an agent with `rtk init` and see the first savings.
+- [How RTK Savings Work](https://github.com/EquityBot/rgg/blob/develop/docs/guide/resources/savings-explained.md): what the savings figures measure and what they do not.
+
+## Docs
+
+The guide is this repository's copy of the RTK guide; its install commands install upstream RTK, not RGG.
+
+- [Configuration](https://github.com/EquityBot/rgg/blob/develop/docs/guide/getting-started/configuration.md): `config.toml`, environment variables and per-project filters.
+- [Supported Agents](https://github.com/EquityBot/rgg/blob/develop/docs/guide/getting-started/supported-agents.md): set-up for each supported agent.
+- [What RTK Optimizes](https://github.com/EquityBot/rgg/blob/develop/docs/guide/resources/what-rtk-covers.md): commands and ecosystems covered.
+- [Token Savings Analytics](https://github.com/EquityBot/rgg/blob/develop/docs/guide/analytics/gain.md): measuring savings with `rtk gain`.
+- [Pipelines](https://github.com/EquityBot/rgg/blob/develop/docs/guide/pipelines/overview.md): composing the engine with `pipeline.toml`.
+- [RTK Proxy](https://github.com/EquityBot/rgg/blob/develop/docs/guide/proxy/overview.md): the separate `rtk-proxy` daemon.
+- [Editions and Licensing](https://github.com/EquityBot/rgg/blob/develop/docs/guide/resources/editions.md): the Apache-2.0 edition and the BUSL-1.1 engine.
+- [Telemetry & Privacy](https://github.com/EquityBot/rgg/blob/develop/docs/guide/resources/telemetry.md): what is collected and how to opt out.
+- [Troubleshooting](https://github.com/EquityBot/rgg/blob/develop/docs/guide/resources/troubleshooting.md): common issues and fixes.
+- [Contributing](https://github.com/EquityBot/rgg/blob/develop/CONTRIBUTING.md): PR process and checks.
+- [Security Policy](https://github.com/EquityBot/rgg/blob/develop/SECURITY.md): reporting a vulnerability.
+
+## Related
+
+- [EquityBot](https://github.com/EquityBot): other EquityBot tools.
+- [RTK](https://github.com/rtk-ai/rtk): the upstream project RGG tracks.