~yoctocell/peertube

5cb5082cf36da47e9e14d28b9507716b69309762 — yoctocell 1 year, 9 months ago 63fb03a
Use README.md
2 files changed, 44 insertions(+), 4 deletions(-)

A README.md
M README.org
A README.md => README.md +43 -0
@@ 0,0 1,43 @@
peertube.el
===========

`peertube.el` is an Emacs interface for
[PeerTube](https://joinpeertube.org), heavily insipred by
[ytel](https://github.com/gRastello/ytel).

![](./demo.png)

Features
========

-   Integration with
    [transmission.el](https://github.com/a13/transmission.el) for
    downloading videos
-   It uses [tabulated list
    mode](https://www.gnu.org/software/emacs/manual/html_node/elisp/Tabulated-List-Mode.html)
    and comes with the features associated with it

Keybindings
===========

| Key | Function               |
|-----|------------------------|
| n   | next line              |
| p   | previous line          |
| o   | open video             |
| d   | download video         |
| s   | search for video       |
| g   | refresh search results |

TODOs
=====

-   \[X\] Integrate with transmission
-   \[X\] Colors based on the color theme
-   \[X\] Change sorting method
-   \[X\] Open channel link
-   \[X\] Select resolution when downloading
-   \[X\] Preview thumbnail
-   \[ \] Let users specify other fields
-   \[ \] Show more metadata
-   \[ \] Add to MELPA

M README.org => README.org +1 -4
@@ 1,12 1,9 @@
* peertube.el
=peertube.el= is an Emacs interface for [[search.joinpeertube.org][PeerTube]], heavily insipred by [[https://github.com/gRastello/ytel][ytel]].

*Note*: This is still in alpha stage.
=peertube.el= is an Emacs interface for [[https://joinpeertube.org][PeerTube]], heavily insipred by [[https://github.com/gRastello/ytel][ytel]].

[[./demo.png]]

* Features
- Respects your native color theme
- Integration with [[https://github.com/a13/transmission.el][transmission.el]] for downloading videos
- It uses [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Tabulated-List-Mode.html][tabulated list mode]] and comes with the features associated with it