xfeed 0.1.0 → 0.1.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 +26 -1
  2. package/package.json +2 -1
package/README.md CHANGED
@@ -2,4 +2,29 @@
2
2
 
3
3
  [![CI](https://github.com/ainergiz/xfeed/actions/workflows/ci.yml/badge.svg)](https://github.com/ainergiz/xfeed/actions/workflows/ci.yml)
4
4
 
5
- Terminal based interface for X, everything app
5
+ Terminal-based X/Twitter viewer with vim-style navigation.
6
+
7
+ ## Install
8
+
9
+ Requires [Bun](https://bun.sh):
10
+
11
+ ```bash
12
+ bun install -g xfeed
13
+ ```
14
+
15
+ > **Note:** `npm install` won't work - xfeed requires the Bun runtime.
16
+
17
+ ## Requirements
18
+
19
+ - macOS or Linux
20
+ - [Bun](https://bun.sh) >= 1.0
21
+ - A terminal with true color support (iTerm2, Ghostty, Kitty, Warp)
22
+ - X/Twitter cookies in a supported browser (Safari, Chrome, Arc, Brave, Firefox)
23
+
24
+ ## Usage
25
+
26
+ ```bash
27
+ xfeed
28
+ ```
29
+
30
+ On first run, you'll be prompted to select a browser to read cookies from.
package/package.json CHANGED
@@ -1,6 +1,7 @@
1
1
  {
2
2
  "name": "xfeed",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
+ "description": "Terminal-based X/Twitter viewer with vim-style navigation. Install with: bun install -g xfeed",
4
5
  "type": "module",
5
6
  "bin": "./src/index.tsx",
6
7
  "scripts": {