diff README @ 0:6369453d47a3

Initial revision
author Guido Berhoerster <guido+managesieve@berhoerster.name>
date Thu, 15 Oct 2020 09:11:05 +0200
parents
children 3fe1614de42c
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Thu Oct 15 09:11:05 2020 +0200
@@ -0,0 +1,80 @@
+managesieve
+===========
+
+Description
+-----------
+
+The package managesieve implements the ManageSieve protocol as specified in
+RFC 5804.  It covers all mandatory parts of the protocol with the exception of
+the SCRAM-SHA-1 SASL mechanism.  Additional SASL authentication mechanisms can
+be provided by consumers.
+
+A command-line ManageSieve client called sievemgr is included and provides an
+example of how the package may be used.
+
+Usage
+-----
+
+API documentation and usage examples can be displayed using the `go doc`
+command or accessed on [pkg.go.dev][1].
+
+[1]: https://pkg.go.dev/go.guido-berhoerster.org/managesieve
+     "managesieve documentation"
+
+Build Instructions
+------------------
+
+managesieve is a Go module and requires Go version 1.14 or later.  It can be
+used by including its canonical name "go.guido-berhoerster.org/managesieve".
+See the Go documentation for details.
+
+The sievemgr utility can be built using the `go build` command.  See the Go
+documentation for details.
+
+Contact
+-------
+
+Please send any feedback, translations or bug reports via email to
+<guido+managesieve@berhoerster.name>.
+
+Bug Reports
+-----------
+
+When sending bug reports, please always mention the exact version of the
+managesieve package with which the issue occurs as well as the Go
+compiler and version and version of the operating system you are using
+and make sure that you provide sufficient information to reproduce the issue
+and include any input, output, any error messages.
+
+In case of build issues, please also specify the implementations and versions
+of the tools used to build the package and/or program, in particular the Go
+compiler.
+
+In case of crashes, please attach the full backtrace to the bug report.
+
+License
+-------
+
+Except otherwise noted, all files are Copyright (C) 2020 Guido Berhoerster and
+distributed under the following license terms:
+
+Copyright (C) 2020 Guido Berhoerster <guido+managesieve@berhoerster.name>
+
+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.