Commit a7e12d13 authored by yPhil's avatar yPhil
Browse files

DOC: Official wording

parent 28b275cb
......@@ -7,15 +7,27 @@
[![License GPLv3](]( [![Liberapay](](
[![PayPal Donate](](
[Ptrolette Official website](
[Pétrolette Official website](
Read about it in French [ici]( ; Test instance [here](
## 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]( 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]( ;
- 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 “” and Pétrolette will search the NYT domain and find its source: (it’s ;
- 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](
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]( (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")
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