README.md 3.29 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) [![Liberapay](https://img.shields.io/badge/donate-Liberapay-yellow.svg)](https://liberapay.com/yPhil/donate)
yPhil's avatar
yPhil committed
8
[![PayPal Donate](https://img.shields.io/badge/donate-PayPal.me-ff69b4.svg)](https://www.paypal.me/yphil)
yPhil's avatar
yPhil committed
9

yPhil's avatar
yPhil committed
10
![Pétrolette](https://bytebucket.org/yphil/takeoff.petrolette.space/raw/c51580164590798635d8cbc251de32ba43ea6abb/images/petrolette.png)
yPhil's avatar
yPhil committed
11

yPhil's avatar
yPhil committed
12
[Pétrolette Official website](http://takeoff.petrolette.space)
yPhil's avatar
yPhil committed
13

14
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
15

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

yPhil's avatar
yPhil committed
18
19
20
21
22
23
24
25
26
27
28
29
30
[Pétrolette](http://takeoff.petrolette.space/) is a #paranoid news reader, usable right away (no installation, no registration, nothing) **totally free of charge**. It doesn’t ask you to register or create any sort of account, and won’t even ask your name. What you are reading is nobody’s (and certainly not GAFAM’s) business.

- Add your sources ([exemple of a source](https://hackernoon.com/feed)) ;
- Organize them by creating groups and dragging & droppin’ sources in them ;
- If you don’t know the address/location of the source, just enter a URL like “http://www.nytimes.com” and Pétrolette will search the NYT domain and find its source: (it’s http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml) ;
- If you don’t have an URL, **you can even enter any term**, like "bitcoin crash" or "Zombie outbreak" and Pétrolette will build a "search source" that gets updated every time something happens.
- Check the code, it’s #open.

Pétrolette is a fantastic #news monitoring tool. Do you have researches to make, do you need to monitor tens of video channels, or you need your animals, flowers, all things nature hi-res pictures fix very day? Do you know that [NASA publishes tons of sources](https://www.nasa.gov/content/nasa-rss-feeds#what)?

Pétrolette helps you discover new sources of information ; you read it everyday on your desktop or your phone/whatnot, this is your. Private News. Portal.

Pétrolette is given to you by the Free, Libre & Open-Source movement. I worked months on it (well, I needed it in the 1st place, I use it every hour of every day) and now I’m offering it to you ; [HELP me make it even better](https://liberapay.com/yPhil/donate) (yes, it’s possible) !!
yPhil's avatar
yPhil committed
31

yPhil's avatar
yPhil committed
32
33
34
35
36
37
38
39
40
41
### 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
42

yPhil's avatar
yPhil committed
43
### LICENSE
yPhil's avatar
yPhil committed
44

yPhil's avatar
yPhil committed
45
46
47
48
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
49

yPhil's avatar
yPhil committed
50
51
52
53
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
54

yPhil's avatar
yPhil committed
55
56
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
57

yPhil's avatar
yPhil committed
58
*Icon by Dave Gandy*
yPhil's avatar
yPhil committed
59

yPhil's avatar
yPhil committed
60
---