From a15b90528f3d1c4d1350e153b59c37e824eafb0d Mon Sep 17 00:00:00 2001 From: Owen Schwartz Date: Sat, 4 Jan 2025 21:23:40 -0500 Subject: [PATCH] Updating overviews and add license --- LICENSE | 21 +++++++++++++++++++ README.md | 4 ++++ .../docusaurus/docs/05-Gerbil/overview.md | 4 ++-- packages/docusaurus/docs/06-Newt/overview.md | 4 ++-- packages/docusaurus/docs/07-roadmap.md | 2 ++ 5 files changed, 31 insertions(+), 4 deletions(-) create mode 100644 LICENSE create mode 100644 packages/docusaurus/docs/07-roadmap.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0029d6d --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Fossorial LLC + +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. diff --git a/README.md b/README.md index 0c6c2c2..422000b 100644 --- a/README.md +++ b/README.md @@ -39,3 +39,7 @@ $ GIT_USER= yarn deploy ``` If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. + +# License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. \ No newline at end of file diff --git a/packages/docusaurus/docs/05-Gerbil/overview.md b/packages/docusaurus/docs/05-Gerbil/overview.md index 690f6f6..96381cc 100644 --- a/packages/docusaurus/docs/05-Gerbil/overview.md +++ b/packages/docusaurus/docs/05-Gerbil/overview.md @@ -1,8 +1,8 @@ # Overview -Gerbil is a simple WireGuard interface management server written in Go. Gerbil makes it easy to create WireGuard interfaces as well as add and remove peers with an HTTP. +Gerbil is a simple [WireGuard](https://www.wireguard.com/) interface management server written in Go. Gerbil makes it easy to create WireGuard interfaces as well as add and remove peers with an HTTP API. -Gerbil can be used stand alone with your own API, a static JSON file, or with Pangolin and Newt as part of the larger system. See documentation below: +Gerbil can be used stand alone with your own API, a static JSON file, or with Pangolin and Newt as part of the larger system. ## Preview diff --git a/packages/docusaurus/docs/06-Newt/overview.md b/packages/docusaurus/docs/06-Newt/overview.md index e6e9d25..85ae345 100644 --- a/packages/docusaurus/docs/06-Newt/overview.md +++ b/packages/docusaurus/docs/06-Newt/overview.md @@ -1,8 +1,8 @@ # Overview -Newt is a fully user space [WireGuard](https://www.wireguard.com/) tunnel client and TCP/UDP proxy, designed to securely expose private resources controlled by Pangolin. By using Newt, you don't need to manage complex WireGuard tunnels and NATing to expose your resources. +Newt is a fully user space [WireGuard](https://www.wireguard.com/) tunnel client and TCP/UDP proxy, designed to securely expose private resources controlled by Pangolin. By using Newt, you don't need to manage complex WireGuard tunnels and NATing. -Newt is used with Pangolin and Gerbil as part of the larger system. See documentation below: +Newt is used with Pangolin and Gerbil as part of the larger system. ## Preview diff --git a/packages/docusaurus/docs/07-roadmap.md b/packages/docusaurus/docs/07-roadmap.md new file mode 100644 index 0000000..0fbad3c --- /dev/null +++ b/packages/docusaurus/docs/07-roadmap.md @@ -0,0 +1,2 @@ +# Road Map +