mirror of
https://github.com/MalteT/mensa.git
synced 2024-10-22 21:59:17 +02:00
Update README
This commit is contained in:
parent
330070a701
commit
869c3f789a
|
@ -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)
|
||||
|
||||
|
||||
# mensa
|
||||
|
||||
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)
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
- [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] Fuzzy date parsing based on
|
||||
[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
|
||||
|
||||
### Cargo
|
||||
|
||||
**Only nightly Rust supported at the moment**.
|
||||
|
||||
```console
|
||||
$ 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
|
||||
IP in a default radius of 10km.
|
||||
- `mensa tags` will list the currently known meal tags like "**12** Nuts".
|
||||
- `mensa tomorrow` shortcut for `mensa meals -d tomorrow [...]`
|
||||
|
||||
|
||||
## Configuration
|
||||
|
|
2
src/cache/mod.rs
vendored
2
src/cache/mod.rs
vendored
|
@ -100,7 +100,7 @@ where
|
|||
{
|
||||
// Normalize the url at this point since we're using it
|
||||
// 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();
|
||||
info!("Fetching {:?}", url);
|
||||
// Try getting the value from cache, if that fails, query the web
|
||||
|
|
|
@ -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)
|
||||
//!
|
||||
//!
|
||||
//! # mensa
|
||||
//!
|
||||
//! 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)
|
||||
//!
|
||||
//!
|
||||
//! ## Features
|
||||
//!
|
||||
//! - [X] Runs on Linux, macOS and Windows.
|
||||
|
@ -18,13 +20,16 @@
|
|||
//! - [X] All request are cached locally.
|
||||
//! - [X] Fuzzy date parsing based on
|
||||
//! [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
|
||||
//!
|
||||
//! ### Cargo
|
||||
//!
|
||||
//! **Only nightly Rust supported at the moment**.
|
||||
//!
|
||||
//! ```console
|
||||
//! $ cargo install --git https://github.com/MalteT/mensa
|
||||
//! ```
|
||||
|
@ -50,7 +55,6 @@
|
|||
//! - `mensa canteens` lists canteens near you based on your current
|
||||
//! IP in a default radius of 10km.
|
||||
//! - `mensa tags` will list the currently known meal tags like "**12** Nuts".
|
||||
//! - `mensa tomorrow` shortcut for `mensa meals -d tomorrow [...]`
|
||||
//!
|
||||
//!
|
||||
//! ## Configuration
|
||||
|
|
Loading…
Reference in a new issue