generate documentation #100

Author: tbela99

.gitattributes

@@ -1,5 +1,8 @@
 /test/ export-ignore
 /docs/ export-ignore
+/typedoc.json export-ignore
+/docs/ export-ignore
+/.typedoc-tsconfig.jsonc export-ignore
 /.editorconfig export-ignore
 /build.sh export-ignore linguist-vendored
 /Writerside export-ignore linguist-vendored

.gitignore

@@ -4,7 +4,6 @@
 /.idea
 /.DS_Store
 /ROADMAP.md
-/docs
 /package-lock.json
 test/*.ts
 test/*.js

.npmignore

@@ -19,4 +19,7 @@
 /validator
 /sw.js
 /jsr.json
-/.editorconfig
+/.editorconfig
+/typedoc-tsconfig.jsonc
+/typedoc.json
+/docs

README.md

@@ -134,7 +134,9 @@ Parse and render css in a single pass.
 
 ```typescript
 
-transform(css, transformOptions: TransformOptions = {}): TransformResult
+transform(css: string | ReadableStream<string>, transformOptions: TransformOptions = {}): TransformResult
+parse(css: string | ReadableStream<string>, parseOptions: ParseOptions = {}): ParseResult;
+render(ast: AstNode, renderOptions: RenderOptions = {}): RenderResult;
 ```
 
 ### Example
@@ -146,6 +148,21 @@ import {transform} from '@tbela99/css-parser';
 const {ast, code, map, errors, stats} = await transform(css, {minify: true, resolveImport: true, cwd: 'files/css'});
 ```
 
+### Example
+
+Read from stdin with node using readable stream
+
+```typescript
+import {transform} from "../src/node";
+import {Readable} from "node:stream";
+import type {TransformResult} from '../src/@types/index.d.ts';
+
+const readableStream: ReadableStream<string> = Readable.toWeb(process.stdin) as ReadableStream<string>;
+const result: TransformResult = await transform(readableStream, {beautify: true});
+
+console.log(result.code);
+```
+
 ### TransformOptions
 
 Include ParseOptions and RenderOptions
@@ -215,17 +232,17 @@ Include ParseOptions and RenderOptions
   - true: same as ColorType.HEX
   - false: no color conversion
   - ColorType.HEX
-  - ColorType.RGB/ColorType.RGBA
+  - ColorType.RGB or ColorType.RGBA
   - ColorType.HSL
   - ColorType.HWB
-  - ColorType.CMYK/ColorType.DEVICE_CMYK
+  - ColorType.CMYK or ColorType.DEVICE_CMYK
   - ColorType.SRGB
   - ColorType.SRGB_LINEAR
   - ColorType.DISPLAY_P3
   - ColorType.PROPHOTO_RGB
   - ColorType.A98_RGB
   - ColorType.REC2020
-  - ColorType.XYZ/ColorType.XYZ_D65
+  - ColorType.XYZ or ColorType.XYZ_D65
   - ColorType.XYZ_D50
   - ColorType.LAB
   - ColorType.LCH