create-markdown - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

dist/index.cjs

@@ -45,3 +45,3 @@ var __defProp = Object.defineProperty;
 }
-var VERSION = "0.1.0";
+var VERSION = "0.1.1";
 var src_default = createMarkdown;

dist/index.d.ts

@@ -33,4 +33,4 @@ /**
  */
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.1.1";
 export default createMarkdown;
 //# sourceMappingURL=index.d.ts.map

dist/index.js

@@ -10,3 +10,3 @@ // src/index.ts
 }
-var VERSION = "0.1.0";
+var VERSION = "0.1.1";
 var src_default = createMarkdown;
@@ -13,0 +13,0 @@ export {

package.json

 {
   "name": "create-markdown",
-  "version": "0.1.0",
+  "version": "0.1.1",
+  "author": "Val Alexander <[e-mail]>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BunsDev/create-markdown"
+  },
+  "homepage": "https://github.com/BunsDev/create-markdown",
+  "bugs": {
+    "url": "https://github.com/BunsDev/create-markdown/issues"
+  },
   "description": "Minimal markdown package for creating and manipulating markdown content",
+  "license": "MIT",
+  "keywords": [
+    "markdown",
+    "md",
+    "bun",
+    "typescript"
+  ],
   "type": "module",
@@ -31,12 +47,8 @@ "main": "./dist/index.cjs",
     "clean": "rm -rf dist",
-    "prepublishOnly": "bun run clean && bun run build"
+    "prepublish": "bun run clean && bun run build",
+    "publish": "bun publish --access public",
+    "deploy": "./deploy.sh",
+    "playground": "bun run build && cd playground && bun dev",
+    "playground:install": "cd playground && bun install"
   },
-  "keywords": [
-    "markdown",
-    "md",
-    "bun",
-    "typescript"
-  ],
-  "author": "",
-  "license": "MIT",
   "devDependencies": {
@@ -46,5 +58,5 @@ "typescript": "^5.3.0"
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "packageManager": "bun@1.0.0"
 }

README.md

 # create-markdown
 
+[![npm version](https://img.shields.io/npm/v/create-markdown.svg)](https://www.npmjs.com/package/create-markdown)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 Markdown package to enable creating markdown interfaces seamlessly because it is complicated and annoying asf.
 
+📦 **[View on npm](https://www.npmjs.com/package/create-markdown)**
+
 ## Installation
@@ -32,2 +37,11 @@
 
+### Default Export
+
+```typescript
+import createMarkdown from 'create-markdown';
+
+const doc = createMarkdown('# Hello World');
+console.log(doc.content);
+```
+
 ### CommonJS
@@ -71,2 +85,12 @@
 
+### `VERSION`
+
+Package version string.
+
+```typescript
+import { VERSION } from 'create-markdown';
+
+console.log(VERSION); // '0.1.1'
+```
+
 ## Development
@@ -86,6 +110,22 @@
 bun run clean
+
+# Run the playground
+bun run playground
 ```
 
+## Requirements
+
+- Node.js 20+
+- Bun 1.0+ (for development)
+
+## Contributing
+
+We welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
+
+## Changelog
+
+See [CHANGELOG.md](./CHANGELOG.md) for release history.
+
 ## License
 
 MIT

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

No website

Quality

Package does not have a website.

Improved metrics

Total package byte prevSize

8398

18.78%

Number of low maintenance alerts

0

-100%

Number of low quality alerts

2

-33.33%

Number of lines in readme file

129

44.94%

Number of low supply chain risk alerts

0

-100%

Number of medium supply chain risk alerts

0

-100%

No dependency changes