megamanmalte/mensa
1
0
Fork 0
mirror of https://github.com/MalteT/mensa.git synced 2024-10-23 06:09:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse source
This commit is contained in:
Malte Tammena 2021-10-24 17:16:49 +02:00
parent 330070a701
commit 869c3f789a
3 changed files with 13 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -2,6 +2,7 @@
[![tests](https://github.com/MalteT/mensa/actions/workflows/rust.yml/badge.svg)](https://github.com/MalteT/mensa/actions/workflows/rust.yml) [![tests](https://github.com/MalteT/mensa/actions/workflows/rust.yml/badge.svg)](https://github.com/MalteT/mensa/actions/workflows/rust.yml)
# mensa # mensa
CLI tool to query the menu of canteens contained in the CLI tool to query the menu of canteens contained in the
@ -9,6 +10,7 @@ CLI tool to query the menu of canteens contained in the
![example](https://user-images.githubusercontent.com/11077981/137278085-75ec877a-dba0-44bb-a8dc-6c802e24178c.png) ![example](https://user-images.githubusercontent.com/11077981/137278085-75ec877a-dba0-44bb-a8dc-6c802e24178c.png)
## Features ## Features
- [X] Runs on Linux, macOS and Windows. - [X] Runs on Linux, macOS and Windows.
@ -18,13 +20,16 @@ CLI tool to query the menu of canteens contained in the
- [X] All request are cached locally. - [X] All request are cached locally.
- [X] Fuzzy date parsing based on - [X] Fuzzy date parsing based on
[date_time_parser](https://lib.rs/crates/date_time_parser). [date_time_parser](https://lib.rs/crates/date_time_parser).
- [ ] List your favourite meals in canteens close to your location. - [X] List your favourite meals in canteens close to your location.
- [X] JSON Output
## Installation ## Installation
### Cargo ### Cargo
**Only nightly Rust supported at the moment**.
```console ```console
$ cargo install --git https://github.com/MalteT/mensa $ cargo install --git https://github.com/MalteT/mensa
``` ```
@ -50,7 +55,6 @@ See `mensa --help`.
- `mensa canteens` lists canteens near you based on your current - `mensa canteens` lists canteens near you based on your current
IP in a default radius of 10km. IP in a default radius of 10km.
- `mensa tags` will list the currently known meal tags like "**12** Nuts". - `mensa tags` will list the currently known meal tags like "**12** Nuts".
- `mensa tomorrow` shortcut for `mensa meals -d tomorrow [...]`
## Configuration ## Configuration

2
src/cache/mod.rs vendored
View file

@ -100,7 +100,7 @@ where
{ {
// Normalize the url at this point since we're using it // Normalize the url at this point since we're using it
// as the cache key // as the cache key
let url = Url::parse(url.as_ref()).map_err(|_| Error::InternalUrlError)?; let url = Url::parse(url.as_ref()).map_err(|_| Error::InternalUrl)?;
let url = url.as_ref(); let url = url.as_ref();
info!("Fetching {:?}", url); info!("Fetching {:?}", url);
// Try getting the value from cache, if that fails, query the web // Try getting the value from cache, if that fails, query the web

8
src/main.rs
View file

@ -2,6 +2,7 @@
//! //!
//! [![tests](https://github.com/MalteT/mensa/actions/workflows/rust.yml/badge.svg)](https://github.com/MalteT/mensa/actions/workflows/rust.yml) //! [![tests](https://github.com/MalteT/mensa/actions/workflows/rust.yml/badge.svg)](https://github.com/MalteT/mensa/actions/workflows/rust.yml)
//! //!
//!
//! # mensa //! # mensa
//! //!
//! CLI tool to query the menu of canteens contained in the //! CLI tool to query the menu of canteens contained in the
@ -9,6 +10,7 @@
//! //!
//! ![example](https://user-images.githubusercontent.com/11077981/137278085-75ec877a-dba0-44bb-a8dc-6c802e24178c.png) //! ![example](https://user-images.githubusercontent.com/11077981/137278085-75ec877a-dba0-44bb-a8dc-6c802e24178c.png)
//! //!
//!
//! ## Features //! ## Features
//! //!
//! - [X] Runs on Linux, macOS and Windows. //! - [X] Runs on Linux, macOS and Windows.
@ -18,13 +20,16 @@
//! - [X] All request are cached locally. //! - [X] All request are cached locally.
//! - [X] Fuzzy date parsing based on //! - [X] Fuzzy date parsing based on
//! [date_time_parser](https://lib.rs/crates/date_time_parser). //! [date_time_parser](https://lib.rs/crates/date_time_parser).
//! - [ ] List your favourite meals in canteens close to your location. //! - [X] List your favourite meals in canteens close to your location.
//! - [X] JSON Output
//! //!
//! //!
//! ## Installation //! ## Installation
//! //!
//! ### Cargo //! ### Cargo
//! //!
//! **Only nightly Rust supported at the moment**.
//!
//! ```console //! ```console
//! $ cargo install --git https://github.com/MalteT/mensa //! $ cargo install --git https://github.com/MalteT/mensa
//! ``` //! ```
@ -50,7 +55,6 @@
//! - `mensa canteens` lists canteens near you based on your current //! - `mensa canteens` lists canteens near you based on your current
//! IP in a default radius of 10km. //! IP in a default radius of 10km.
//! - `mensa tags` will list the currently known meal tags like "**12** Nuts". //! - `mensa tags` will list the currently known meal tags like "**12** Nuts".
//! - `mensa tomorrow` shortcut for `mensa meals -d tomorrow [...]`
//! //!
//! //!
//! ## Configuration //! ## Configuration