From f79a2968f8e1fccbcb57bc014b10dd1b424bd54f Mon Sep 17 00:00:00 2001 From: Peter Sanchez Date: Mon, 22 Aug 2022 15:29:08 -0600 Subject: [PATCH] Adding README and LICENSE files --- LICENSE | 32 ++++++++++++++++++++++++++++++++ README.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a781287 --- /dev/null +++ b/LICENSE @@ -0,0 +1,32 @@ +Copyright (c) 2021, Netlandish Inc. +All rights reserved. + +Redistribution and use in source and binary forms, with or +without modification, are permitted provided that the +following conditions are met: + + * Redistributions of source code must retain the above + copyright notice, this list of conditions and the + following disclaimer. + + * Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials + provided with the distribution. + + * Neither the name of Peter Sanchez nor the names of its + contributors may be used to endorse or promote products + derived from this software without specific prior written + permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED +TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4f5392a --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# gobwebs + +**USE AT YOUR OWN RISK.** This module, while is working in production, is not +considered production ready. It is not yet version 1 ready and the API will no +doubt change on core pieces. If you're adventurous then enjoy. + +This is a simple set of utilities to help make it easier to write web +applications in Golang. It uses the echo framework. Some of the batteries +included: + +- User management + - Login (password or magic email link) + - Change password + - Forgot password + - Change email +- Confirmation management +- Storage (local fs or S3) +- Custom form validation (combining echo and validator) +- Built in async queue support +- Custom email interfaces using carrier +- Lots of template helpers +- Built in localization + +Requires Go 1.18+ and PostgreSQL. + +Seriously lacking documentation, base sql tables for users and confirmations, +and more. Like we said, don't use this yet. You've been warned :) + +Licensed under the BSD license. See LICENSE file -- 2.45.2