@gesslar/bedoc 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +3 -3
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -38,10 +38,10 @@ Install BeDoc globally using NPM:
38
38
  npm install -g bedoc
39
39
  ```
40
40
 
41
- Or add it to your project as a dependency:
41
+ Or add it to your project as a dev dependency:
42
42
 
43
43
  ```bash
44
- npm install bedoc
44
+ npm install bedoc --save-dev
45
45
  ```
46
46
 
47
47
  ---
@@ -51,7 +51,7 @@ npm install bedoc
51
51
  Here’s how to use BeDoc programmatically:
52
52
 
53
53
  ```javascript
54
- const BeDoc = require('bedoc');
54
+ import BeDoc from "@gesslar/bedoc"
55
55
 
56
56
  // Initialize BeDoc with your configuration
57
57
  const docGenerator = new BeDoc({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gesslar/bedoc",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Pluggable documentation engine for any language and format",
5
5
  "publisher": "gesslar",
6
6
  "main": "./src/core/Core.js",