From 1ffee75cfb8481f74c46251e7b3a0cf4b6e925eb Mon Sep 17 00:00:00 2001
From: adisbladis <adisbladis@gmail.com>
Date: Fri, 24 Jul 2020 14:01:04 +0200
Subject: [PATCH] Add README file

---
 LICENSE   | 21 +++++++++++++++++++++
 README.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 63 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..6d26ffe
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Tweag I/O
+
+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
new file mode 100644
index 0000000..f36d038
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# Gomod2nix
+Convert applications using Go modules -> Nix
+
+## Usage
+From the Go project directory execute:
+``` bash
+$ gomod2nix
+```
+
+This will create `gomod2nix.toml` that's used like so
+``` nix
+let
+  pkgs = import <nixpkgs> {
+    overlays = [
+      (self: super: {
+        buildGoApplication = super.callPackage ./builder { };
+      })
+    ];
+  };
+in pkgs.buildGoApplication {
+  pname = "gomod2nix-example";
+  version = "0.1";
+  src = ./.;
+  modules = ./gomod2nix.toml;
+}
+```
+
+## FAQ
+
+### Why not continue work on vgo2nix?
+Vgo2nix was built on top of the old Nixpkgs build abstraction `buildGoPackage`, this abstraction was built pre-modules and suffered from some fundamental design issues with modules, such as only allowing a single version of a Go package path inside the same build closure, something that Go itself allows for.
+
+We need a better build abstraction that takes Go modules into account, while remaining [import from derivation](https://nixos.wiki/wiki/Import_From_Derivation)-free.
+
+### Will this be included in Nixpkgs
+
+Yes. Once the API is considered stable.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE)
+file for details.