From 64a4a42cde4d19d3614279a01fff757fe74c7bc2 Mon Sep 17 00:00:00 2001 From: Brad Fitzpatrick Date: Sat, 1 Jun 2013 06:14:54 -0700 Subject: [PATCH] readme --- LICENSE | 27 +++++++++++++++++++++++++++ README.txt | 23 +++++++++++++++++++++++ 2 files changed, 50 insertions(+) create mode 100644 LICENSE create mode 100644 README.txt diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..65d761b --- /dev/null +++ b/LICENSE @@ -0,0 +1,27 @@ +Copyright (c) 2013 The Go Authors. 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 Google Inc. 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 +OWNER 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.txt b/README.txt new file mode 100644 index 0000000..08c8afb --- /dev/null +++ b/README.txt @@ -0,0 +1,23 @@ +This tool updates your Go imports, adding missing ones and removing +unreferenced onces. + +It's a fork of gofmt, and will also fmt your code, so it can be used +as a replacement for your gofmt-on-save hook in your editor. + +Caveats: + +For adding, it currently only knows about the standard library. There +is not yet support for searching/indexing GOPATH or calling out to a +helper program to look up from "foo.Bar" to the necessary import. + +For removal, it assumes the import path base matches the package name, +which is best practice anyway, like: + + import "github.com/you/foo" // assumes to import package "foo" + +If they don't match, explictly name the package name in your import +line: + + import foo "github.com/you/not-quite-foo" + +These caveats might be fixed.