open-tax 0.0.0-stage → 0.1.0

package/NOTICE

@@ -0,0 +1,39 @@
+Open-Tax
+Copyright 2026 GLC Works
+
+This product is licensed under the Apache License, Version 2.0
+(the "License"). You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Attribution
+-----------
+Open-Tax is a project of GLC Works:
+https://github.com/glc-works/open-tax
+
+If you redistribute the Work or a Derivative Work, keep a copy of this
+NOTICE with the distribution. Apache-2.0 Section 4(d) requires that
+notices contained in a NOTICE file be included with Derivative Works.
+
+Third-party projects
+--------------------
+Open-Tax does not copy source code from GOBL (https://github.com/invopop/gobl),
+OpenFisca (https://openfisca.org/), or datasets/harmonized-system
+(https://github.com/datasets/harmonized-system). Those projects are
+credited as architectural inspiration in README.md and benchmarks/.
+They remain under their own licenses. Do not remove those credits from
+derivative documentation that still relies on the comparison.
+
+Legal texts
+-----------
+Names of statutes, article numbers, rates copied from those sources, and
+official URLs are included so maintainers can check primary materials.
+They are identifications of law, not a republication of the official
+texts. Tax administrations and gazette publishers retain whatever rights
+they hold in their own publications.

package/README.md

@@ -1,3 +1,61 @@
-# Temporary Holding Version
+# open-tax
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Reference loader and command-line tool for [Open-Tax](https://github.com/glc-works/open-tax) jurisdiction packs.
+
+Apache-2.0. See the repository [NOTICE](https://github.com/glc-works/open-tax/blob/main/NOTICE) for the attribution redistributors keep under Section 4(d).
+
+## Install
+
+Requires Node.js 20 or newer.
+
+```bash
+npx open-tax --help
+pnpm dlx open-tax --help
+npm install -g open-tax
+pnpm add -g open-tax
+```
+
+Homebrew:
+
+```bash
+brew tap glc-works/tap
+brew install open-tax
+```
+
+`brew install glc-works/tap/open-tax` is the same command. The tap formula is maintained from [`packaging/homebrew`](https://github.com/glc-works/open-tax/blob/main/packaging/homebrew/README.md).
+
+Use the library from another project with `npm install open-tax` or `pnpm add open-tax`.
+
+## Command line
+
+```bash
+open-tax --help
+open-tax --version
+open-tax validate
+open-tax validate packs/id
+open-tax validate packs/id/regime.json
+open-tax resolve packs/id/regime.json --date 2025-06-01 [--semantic <code>] [--tax <id>] [--treatment <id>]
+```
+
+`validate` checks a checkout that contains `schemas/` and `packs/`, one pack folder, or a `regime.json` file. With no path, it searches upward from the current directory.
+
+`resolve` prints the JSON array returned by `resolveTaxAtDate`. `base_formula` and `value` are copied as published. The command does not evaluate the formula.
+
+`--version` reads `version` from this package's `package.json`.
+
+## Library
+
+```ts
+import { validatePack, resolveTaxAtDate, diffPolicyChanges, getSchemas } from "open-tax";
+```
+
+- `validatePack(regime)` checks JSON Schema draft 2020-12 and pack integrity (citations, successor links, non-overlapping dates).
+- `resolveTaxAtDate(regime, { date, treatmentId, semanticCode, taxId })` returns the versions in force on that inclusive date. It returns `base_formula` and any stated `value` as written. It does not evaluate the formula.
+- `diffPolicyChanges(diffs, filter)` filters maintainer-authored policy diffs. `diffPolicyChanges(before, after)` reports structural edits between two regimes and does not invent a legal citation.
+- `getSchemas()` returns the regime, policy-diff, and dictionary schemas. After `npm run build`, the same files are importable as `open-tax/schemas/regime.schema.json` and its siblings.
+
+Build with `npm run build` from this package or from the repository root. The `open-tax` bin is `dist/cli.js` and starts with `#!/usr/bin/env node`.
+
+A dataset pull request does not publish this package. A tag `vX.Y.Z` matching `version` in `package.json` runs the repository release workflow, which publishes to npm when `NPM_TOKEN` is configured.
+
+Pack authoring, country maintainer steps, and the Indonesia starter live in the repository, not in this README.