Browse Source

Add screenshots in the README.md file

This closes issue #16.
responsive
Lucas Verney 6 years ago
parent
commit
9d7707ec4c
  1. 28
      README.md
  2. BIN
      doc/img/details.png
  3. BIN
      doc/img/followed.png
  4. BIN
      doc/img/home.png
  5. BIN
      doc/img/home2.png

28
README.md

@ -9,10 +9,11 @@ database schema could change at any time. Do not consider it as being @@ -9,10 +9,11 @@ database schema could change at any time. Do not consider it as being
production ready. However, I am currently using it for my own housing search
and it is working fine :)
**Note**: For the moment, it requires [this MR on
**Note**: For the moment, it requires [this MR on
Weboob](https://git.weboob.org/weboob/devel/merge_requests/31) which has not
yet been merged.
<img src="doc/img/home.png" width="45%"/> <img src="doc/img/home2.png" width="45%"/>
It uses [Weboob](http://weboob.org/) to get all the housing posts on most of
the websites offering housings posts, and then offers a bunch of pipelines to
@ -44,6 +45,31 @@ See the [getting started guide](doc/0.getting_started.md). @@ -44,6 +45,31 @@ See the [getting started guide](doc/0.getting_started.md).
See the [dedicated folder](doc/).
## Screenshots
### Home page
Display available flats on a map:
<img src="doc/img/home.png"/>
And list them with the details in a sortable table:
<img src="doc/img/home2.png"/>
### Details page
Uniform display of the flat information in a dedicated page, with the contact etc:
<img src="doc/img/details.png"/>
### Follow flats
Track interesting flats and store them with notes:
<img src="doc/img/followed.png"/>
## OpenData
I am using the following datasets, available under `flatisfy/data_files`,

BIN
doc/img/details.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 379 KiB

BIN
doc/img/followed.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 104 KiB

BIN
doc/img/home.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 877 KiB

BIN
doc/img/home2.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 401 KiB

Loading…
Cancel
Save