README.md 2.31 KB
Newer Older
yPhil's avatar
yPhil committed
1
# Petrolette
yPhil's avatar
yPhil committed
2

yPhil's avatar
yPhil committed
3
*RSS/Atom morning news reader ; Works at night too.*
yPhil's avatar
yPhil committed
4

yPhil's avatar
yPhil committed
5
---
yPhil's avatar
yPhil committed
6

yPhil's avatar
yPhil committed
7
[![License GPLv3](https://img.shields.io/badge/license-GPL_v3-green.svg)](http://www.gnu.org/licenses/gpl-3.0.html) [![Gratipay](http://img.shields.io/gratipay/yassinphilip.svg)](https://www.gratipay.com/yassinphilip/)
yPhil's avatar
yPhil committed
8

yPhil's avatar
yPhil committed
9
![Ptrolette](https://yphil.bitbucket.io/images/misc/petrolette-screenshot.png)
yPhil's avatar
yPhil committed
10

yPhil's avatar
yPhil committed
11
[Ptrolette Official website](https://yphil.bitbucket.io/petrolette/)
yPhil's avatar
yPhil committed
12

13
Read about it in French [ici](https://linuxfr.org/users/philippemc/journaux/decollage-de-la-petrolette-de-l-espace) ; Test instance [here](http://petrolette.space/).
yPhil's avatar
yPhil committed
14

yPhil's avatar
yPhil committed
15
## Petrolette is a personal track-free online RSS news reader
yPhil's avatar
yPhil committed
16

yPhil's avatar
yPhil committed
17
Petrolette is a simple but powerful web app to view and manage various XML (RSS, aTom, etc) news feeds and present them in a nice, ergonomic fashion. I made it to replace the online news services (NetVibes, Google news, etc.) that I use up until around 2007, when they became bloated and **lousy with spyware**. It's a fast, simple and light system, and I've been using it for ~~weeks~~ years now ; It does what I want from a no-nonsense, every-morning-every-day news reader.
yPhil's avatar
yPhil committed
18

yPhil's avatar
yPhil committed
19
20
21
22
23
24
25
26
27
28
### Installation

```sh
git clone https://yphil@bitbucket.org/yphil/petrolette.git
cd petrolette
npm install
npm start
firefox http://localhost:8666

```
yPhil's avatar
yPhil committed
29
### Practical Features
yPhil's avatar
yPhil committed
30

yPhil's avatar
yPhil committed
31
Make the page your home page, and read it every morning. You know instantly what article you've read ; We're already on the web, right? Just click and read the article. This is *so much better than TV*.
yPhil's avatar
yPhil committed
32

yPhil's avatar
yPhil committed
33
### Technical Features
yPhil's avatar
yPhil committed
34

yPhil's avatar
yPhil committed
35
36
- Automatic discovery of a website's RSS feed (called "source" in Petrolette)
- Creation of a source from a natural search query ("latest bitcoin crash")
yPhil's avatar
yPhil committed
37

yPhil's avatar
yPhil committed
38
### LICENSE
yPhil's avatar
yPhil committed
39

yPhil's avatar
yPhil committed
40
41
42
43
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
yPhil's avatar
yPhil committed
44

yPhil's avatar
yPhil committed
45
46
47
48
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
yPhil's avatar
yPhil committed
49

yPhil's avatar
yPhil committed
50
51
You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
yPhil's avatar
yPhil committed
52

yPhil's avatar
yPhil committed
53
*Icon by Dave Gandy*
yPhil's avatar
yPhil committed
54

yPhil's avatar
yPhil committed
55
---