xfeed 0.1.2 → 0.1.3

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 (4) hide show
  1. package/LICENSE +0 -2
  2. package/README.md +23 -3
  3. package/dist/index.js +2836 -1529
  4. package/package.json +3 -2
package/LICENSE CHANGED
@@ -2,8 +2,6 @@ MIT License
2
2
 
3
3
  Copyright (c) 2025 Ali Ihsan Nergiz
4
4
 
5
- Based on bird by Peter Steinberger (https://github.com/steipete/bird)
6
-
7
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
8
6
  of this software and associated documentation files (the "Software"), to deal
9
7
  in the Software without restriction, including without limitation the rights
package/README.md CHANGED
@@ -2,7 +2,9 @@
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 X/Twitter viewer with vim-style navigation.
5
+ Terminal-based X.com client with vim-style navigation so you never need to leave your terminal while your agent is on work. Stay dopaminated, stay in the loop :) Built with [OpenTUI](https://github.com/sst/opentui) and [Bun](https://bun.sh).
6
+
7
+ > **Early Development:** This project is in early development. Expect bugs and breaking changes.
6
8
 
7
9
  ## Install
8
10
 
@@ -18,7 +20,7 @@ bun install -g xfeed
18
20
 
19
21
  - macOS or Linux
20
22
  - [Bun](https://bun.sh) >= 1.0
21
- - A terminal with true color support (iTerm2, Ghostty, Kitty, Warp)
23
+ - A terminal with true color support ([Ghostty](https://ghostty.org), [iTerm2](https://iterm2.com), [Kitty](https://sw.kovidgoyal.net/kitty), [Warp](https://warp.dev))
22
24
  - X/Twitter cookies in a supported browser (Safari, Chrome, Arc, Brave, Firefox)
23
25
 
24
26
  ## Usage
@@ -27,4 +29,22 @@ bun install -g xfeed
27
29
  xfeed
28
30
  ```
29
31
 
30
- On first run, you'll be prompted to select a browser to read cookies from.
32
+ On first run, you'll be prompted to select a browser to read cookies from or enter cookies manually.
33
+
34
+ ## Contributing
35
+
36
+ See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
37
+
38
+ ## Disclaimer
39
+
40
+ This project is **not affiliated with, endorsed by, or connected to X Corp (formerly Twitter)** in any way. It uses undocumented APIs which may break at any time. **Use at your own risk.** The authors are not responsible for any consequences of using this software, including but not limited to account restrictions.
41
+
42
+ ## Acknowledgments
43
+
44
+ - [bird](https://github.com/steipete/bird) by Peter Steinberger - X API client implementation
45
+ - [OpenTUI](https://github.com/sst/opentui) - Terminal UI framework
46
+ - [sweet-cookie](https://github.com/steipete/sweet-cookie) - Browser cookie extraction
47
+
48
+ ## License
49
+
50
+ [MIT](LICENSE)