@@ -13,7 +13,7 @@ A TypeScript implementation of JSON-DOC, a standardized format for storing struc
1313## Installation
1414
1515``` bash
16- npm install jsondoc
16+ npm install @textcortex/ jsondoc
1717```
1818
1919## Usage
@@ -22,7 +22,7 @@ npm install jsondoc
2222
2323``` tsx
2424import React from " react" ;
25- import { JsonDocRenderer } from " jsondoc" ;
25+ import { JsonDocRenderer } from " @textcortex/ jsondoc" ;
2626import * as fs from " fs" ;
2727import * as JSON5 from " json5" ;
2828
@@ -43,7 +43,7 @@ function App() {
4343
4444``` tsx
4545import React from " react" ;
46- import { BlockRenderer } from " jsondoc" ;
46+ import { BlockRenderer } from " @textcortex/ jsondoc" ;
4747
4848function MyComponent({ block }) {
4949 return (
@@ -235,13 +235,13 @@ The renderer uses Notion-inspired CSS classes for styling:
235235
236236MIT
237237
238- ## Tooling
238+ ## Configuration
239239
240- - followed this for ts config setup: https://www.totaltypescript.com/tsconfig-cheat-sheet
240+ - TypeScript configuration follows best practices from [ Total TypeScript ] ( https://www.totaltypescript.com/tsconfig-cheat-sheet )
241241
242242## Release workflow
243243
244- We using bumpp to bump package.json and lock, create git tag and commit
244+ We use bumpp to automatically bump package.json and lock files , create git tags and commits
245245
2462461 . Run:
247247
@@ -290,7 +290,7 @@ You can choose a different version from the list or create new one. But bumpp is
290290 - [x] paragraph
291291 - [x] code
292292 - [x] table
293- - [ ] todo?
293+ - [x] to-do items
294294 - [x] equation
295295 - [x] image
296296 - [x] blockquote
@@ -303,8 +303,8 @@ You can choose a different version from the list or create new one. But bumpp is
303303
304304- [x] add counter for numbered lists
305305- [x] setup up bumpp: https://www.npmjs.com/package/bumpp
306- - [ ] migrate test runner to vitest
306+ - [ ] migrate test runner to vitest
307307- [x] move vite app to typescript root examples dir
308- - [ ] setup monorepo tooling
309- - [ ] fix model generation for Image and RichText, then type renderers
310- - [ ] use katex or similar package for equations
308+ - [ ] setup monorepo tooling
309+ - [ ] fix model generation for Image and RichText, then type renderers
310+ - [ ] use katex or similar package for equations
0 commit comments