on master help sign in
executable-config: update readme
commitcc3e53c391dcc988138c6a9009b9f4d4d12d5bc0 authorAli Abrar <aliabrar@gmail.com> dateTue 7 Aug 2018, 18:07 (8 years ago) parent5f26efc
1 file changed+2−7
lib/executable-config/README.md+2−7
lib/executable-config/README.md+2−7
@@ -7,10 +7,6 @@ Obelisk.ExecutableConfig serves two related purposes:
771. Injection: a cross-platform injection function, which can be used to put configuration files in a canonical location.
882. Retrieval: a cross-platform retrieval function that is aware of the canonical location on each platform and how to read files from that location.
99
10−## File Location
11−
12−ExecutableConfig expects your configuration files to be placed in `./config`.
13−
1410## Supported Platforms
1511
1612| Function | iOS | Android | Warp |Web backend + GHCJS |
@@ -28,7 +24,7 @@ ExecutableConfig expects your configuration files to be placed in `./config`.
2824
2925There is currently no `inject` function for `jsaddle-warp`-based frontends.
3026
31−`get` is a Haskell function that simply reads the configuration files from `./config`.
27+`get` is a Haskell function that simply reads the configuration files relative to the current directory.
3228
3329### Web backend + GHCJS
3430
@@ -36,9 +32,8 @@ There is currently no `inject` function for `jsaddle-warp`-based frontends.
3632
3733`inject` is a Haskell function that produces a snippet of HTML that must be appended to the `<head>` of the page that the backend serves (i.e., the entry point for the GHCJS application).
3834
39−`get` is a Haskell function that reads the configuration files from `./config`.
35+`get` is a Haskell function that reads the configuration files relative to the current directory.
4036
4137#### GHCJS
4238
4339`get` is a Haskell function that can be run by the GHCJS frontend to retrieve the injected configuration data from the served `<head>`. There is no `inject` that is run in GHCJS.
44−