@sapphire-caitlyn/schema-kit-ng 0.0.0-stage → 0.0.1

package/README.md

@@ -1,3 +1,34 @@
-# Temporary Holding Version
+# schema-kit (`@schema-kit/ng`)
 
-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.
+Lib de CRUD do backoffice: um `SchemaService` descreve a entidade, o `<schema-table>` faz a listagem e o
+`<schema-view>` faz o criar/editar. Cada componente tem um README ao lado do código, em `src/lib/components/`.
+
+## Entry points
+
+| Import                | Conteúdo                                                   |
+| --------------------- | ---------------------------------------------------------- |
+| `@schema-kit/ng`      | A lib (`src/public-api.ts`)                                |
+| `@schema-kit/ng/helm` | Componentes Spartan (helm) embutidos na lib (`helm/index.ts`) |
+
+No `front-backoffice` a app não usa o pacote: importa o código-fonte pelos aliases do `tsconfig.json` (`@schema-kit`
+e `@schema-kit/ng/helm`), o que mantém o hot reload.
+
+## Build e publicação
+
+Na raiz do `front-backoffice`:
+
+```bash
+npm run build:lib                  # helm:sync + ng build schema-kit → dist/schema-kit
+npm run publish:lib -- --dry-run   # empacota sem publicar
+npm run publish:lib                # build:lib + npm publish ./dist/schema-kit
+```
+
+Antes de publicar, suba a `version` neste `package.json`: o registry recusa uma versão já publicada.
+
+## Dependências
+
+Pacote externo usado pela lib ou pelo helm vai neste `package.json`:
+
+- em `peerDependencies`, quando a app deve fornecer uma cópia única (Angular, `@spartan-ng/brain`, embla, tanstack...);
+- em `dependencies`, para utilitários sem estado (`clsx`, `tailwind-merge`...). Nesse caso liste também em
+  `allowedNonPeerDependencies` do `ng-package.json`, senão o build recusa.