Skip to content

Commit e0cf48b

Browse files
super3claude
andcommitted
Update README formatting and installation instructions
- Move badges below description - Fix badge URL to use test.yml instead of ci.yml - Combine npm install and npm link commands for cleaner instructions 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 24e5a1e commit e0cf48b

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# mdtail.dev
22

3+
A simple terminal app that displays and live-refreshes markdown files.
4+
35
[![npm version](https://badge.fury.io/js/mdtail.svg)](https://www.npmjs.com/package/mdtail)
4-
[![Test Status](https://img.shields.io/github/actions/workflow/status/super3/mdtail.dev/ci.yml?branch=main&label=tests)](https://github.com/super3/mdtail.dev/actions/workflows/ci.yml)
6+
[![Test Status](https://img.shields.io/github/actions/workflow/status/super3/mdtail.dev/test.yml?branch=main&label=tests)](https://github.com/super3/mdtail.dev/actions/workflows/test.yml)
57
[![Coverage Status](https://coveralls.io/repos/github/super3/mdtail.dev/badge.svg?branch=main)](https://coveralls.io/github/super3/mdtail.dev?branch=main)
68
[![License](https://img.shields.io/badge/license-MIT-blue.svg?label=license)](https://github.com/super3/mdtail.dev/blob/main/LICENSE)
79

8-
A simple terminal app that displays and live-refreshes markdown files.
9-
1010
## Features
1111

1212
- 📝 Display markdown files in terminal with formatted output
@@ -27,8 +27,7 @@ npm install -g mdtail
2727
### From Source
2828
```bash
2929
git clone https://github.com/super3/mdtail.dev.git && cd mdtail.dev
30-
npm install
31-
npm link # Install mdtail command globally
30+
npm install && npm link # Install dependencies and mdtail command globally
3231
```
3332

3433
## Usage

0 commit comments

Comments
 (0)