From 44e3fa8f5e130de77f94b42624ef8ad013a4af66 Mon Sep 17 00:00:00 2001 From: Ivan Bushchik Date: Wed, 21 Jun 2023 08:57:00 +0300 Subject: [PATCH] Add README.md and LICENSE --- LICENSE | 20 ++++++++++++++++++++ README.md | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e5e9014 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +MIT License + +Copyright (c) 2023 Ivan Bushchik + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF +OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..1b24731 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# urouter + +Fork of [ivabus/aliurl](https://github.com/ivabus/aliurl) that routes statically. + +## Installation + +```shell +git clone https://github.com/ivabus/urouter +cd urouter +``` + +Edit `alias.json` and `cargo run` + +## `alias.json` example + +```json +[ + { + "uri": "uri", + "alias": "file" + }, + { + "uri": "uri2", + "alias": "http://example.com", + "is_url": true + } +] +``` + +## License + +The project is licensed under the terms of the [MIT license](./LICENSE).% \ No newline at end of file