Fix docs and add caching description.

This commit is contained in:
Maximilian Ammann 2022-01-09 15:03:51 +01:00
parent df1855bb9d
commit 84c650f881
4 changed files with 19 additions and 4 deletions

2
.gitignore vendored
View File

@ -16,5 +16,7 @@ target/
dist/
# Cache by reqwest-middleware-cache
*cache*
logs/

View File

@ -3,11 +3,9 @@
[Introduction](./introduction.md)
[Supported Platforms](./supported-platforms.md)
[Architecture](./architecture.md)
[Caching](./caching.md)
[Building](./building.md)
## Developer Log
I'm regularly releasing blog posts [on my blog](http://localhost:1313/categories/mapr/).
[Developer Log](./developer-log.md)
## Appendix

12
docs/src/caching.md Normal file
View File

@ -0,0 +1,12 @@
# Caching
The caching for mapr is handled on the networking layer. This means that data which is fetched over slow IO is cached in
the format of the network requests. The mapr library is not introducing a separate serialization format for caching.
Instead, caching functionality of HTTP client libraries of the web platform are used. This has the advantage that we can
honor HTTP headers which configure caching. This is very important for fetched tiles, as they can have an expiry date.
* On the web we are using service workers to cache network requests.
* On Linux, MacOs, iOS and Android we are
utilizing [reqwest-middleware-cache](https://crates.io/crates/reqwest-middleware-cache/), which writes raw network
requests to disk.

View File

@ -0,0 +1,3 @@
# Developer Log
I'm regularly releasing blog posts [on my blog](https://maxammann.org/categories/mapr/).