note - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

package.json

 {
   "name": "note",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "A note-taking application built with Bun, React, and Tailwind",
@@ -5,0 +5,0 @@ "type": "module",

README.md

@@ -1,21 +0,97 @@
-# bun-react-tailwind-template
+# note
 
-To install dependencies:
+A simple CLI tool for creating quick timestamped notes as markdown files.
 
+## Quick Start
+
+Create a note instantly without installation:
+
 ```bash
-bun install
+npx note I love tacos
+# Creates: note-2025-07-27-i-love-tacos.md
 ```
 
-To start a development server:
+## Usage with Different Package Managers
 
+### npm/npx
 ```bash
-bun dev
+npx note Your note content here
 ```
 
-To run for production:
+### Bun
+```bash
+bunx note Your note content here
+```
 
+### pnpm
 ```bash
-bun start
+pnpm dlx note Your note content here
 ```
 
-This project was created using `bun init` in bun v1.2.19. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+### Yarn
+```bash
+yarn dlx note Your note content here
+```
+
+## Installation (Optional)
+
+For frequent use, you can install globally:
+
+```bash
+# npm
+npm install -g note
+
+# bun
+bun install -g note
+
+# pnpm
+pnpm add -g note
+
+# yarn
+yarn global add note
+```
+
+After global installation, use directly:
+```bash
+note This is my note
+```
+
+## What It Does
+
+The `note` command creates a markdown file in your current directory with:
+- Filename: `note-YYYY-MM-DD-slugified-content.md`
+- Content: Your note as a markdown heading with timestamp
+
+Example:
+```bash
+$ note Hello world this is a test
+✅ Created: note-2025-07-27-hello-world-this-is-a-test.md
+```
+
+File contents:
+```markdown
+# Hello world this is a test
+
+Created: 2025-07-27T14:30:00.000Z
+```
+
+## Features
+
+- Zero configuration
+- Works with any package manager
+- Creates timestamped markdown files
+- Slugifies your note for clean filenames
+- ESM module (requires Node.js 14+)
+
+## Development
+
+This package also includes a React application. To run the development server:
+
+```bash
+bun install
+bun dev
+```
+
+## License
+
+MIT

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 2 instances in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 2 instances in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

21716

5.84%

Number of lines in readme file

97

340.91%

No dependency changes