Skip to content

Commit ea924de

Browse files
super3claude
andcommitted
Prepare package for npm publishing
- Update package.json with proper metadata - Change package name from mdtail.dev to mdtail - Add keywords for better discoverability - Add MIT license file (Copyright 2025 Shawn Wilkinson) - Create .npmignore to exclude test and dev files - Set minimum Node.js version to 14.0.0 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 6518290 commit ea924de

3 files changed

Lines changed: 83 additions & 4 deletions

File tree

.npmignore

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Test files
2+
test/
3+
*.test.js
4+
jest.config.js
5+
coverage/
6+
7+
# Development files
8+
.github/
9+
.gitignore
10+
.editorconfig
11+
.eslintrc
12+
.prettierrc
13+
.claude/
14+
15+
# Documentation files (keep README.md)
16+
TODO.md
17+
CONTRIBUTING.md
18+
19+
# OS files
20+
.DS_Store
21+
Thumbs.db
22+
23+
# IDE files
24+
.vscode/
25+
.idea/
26+
*.sublime-*
27+
28+
# Logs
29+
*.log
30+
npm-debug.log*
31+
32+
# Environment files
33+
.env
34+
.env.*
35+
36+
# Git files
37+
.git/
38+
.gitattributes

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Shawn Wilkinson
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

package.json

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "mdtail.dev",
2+
"name": "mdtail",
33
"version": "1.0.0",
44
"description": "A simple terminal app that displays and live-refreshes markdown files.",
55
"main": "index.js",
@@ -12,10 +12,30 @@
1212
"test:watch": "jest --watch",
1313
"test:coverage": "jest --coverage"
1414
},
15-
"keywords": [],
16-
"author": "",
17-
"license": "ISC",
15+
"keywords": [
16+
"markdown",
17+
"terminal",
18+
"cli",
19+
"live-reload",
20+
"file-watcher",
21+
"markdown-viewer",
22+
"developer-tools",
23+
"documentation"
24+
],
25+
"author": "Shawn Wilkinson",
26+
"license": "MIT",
1827
"type": "commonjs",
28+
"repository": {
29+
"type": "git",
30+
"url": "git+https://github.com/super3/mdtail.dev.git"
31+
},
32+
"bugs": {
33+
"url": "https://github.com/super3/mdtail.dev/issues"
34+
},
35+
"homepage": "https://github.com/super3/mdtail.dev#readme",
36+
"engines": {
37+
"node": ">=14.0.0"
38+
},
1939
"devDependencies": {
2040
"jest": "^30.0.5"
2141
}

0 commit comments

Comments
 (0)