Commit a7e12d13 authored by yPhil's avatar yPhil
Browse files

DOC: Official wording

parent 28b275cb
......@@ -7,15 +7,27 @@
[![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)
[![PayPal Donate](https://img.shields.io/badge/donate-PayPal.me-ff69b4.svg)](https://www.paypal.me/yphil)
![Ptrolette](https://bytebucket.org/yphil/takeoff.petrolette.space/raw/c51580164590798635d8cbc251de32ba43ea6abb/images/petrolette.png)
![Pétrolette](https://bytebucket.org/yphil/takeoff.petrolette.space/raw/c51580164590798635d8cbc251de32ba43ea6abb/images/petrolette.png)
[Ptrolette Official website](http://takeoff.petrolette.space)
[Pétrolette Official website](http://takeoff.petrolette.space)
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/).
## Petrolette is a personal track-free online RSS news reader
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.
[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) !!
### Installation
......@@ -27,14 +39,6 @@ npm start
firefox http://localhost:8666
```
### Practical Features
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*.
### Technical Features
- Automatic discovery of a website's RSS feed (called "source" in Petrolette)
- Creation of a source from a natural search query ("latest bitcoin crash")
### LICENSE
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment