Add README

4 files changed, 68 insertions, 1 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..94cb787
--- /dev/null
+++ b/README.md
@@ -0,0 +1,63 @@
+This is a [Hugo Components](https://gohugo.io/hugo-modules/) that packages the Bootstrap v4 SCSS source ready to be used in Hugo.
+
+You need the Hugo extended version and Go to use this component.
+
+
+## Use
+
+Add the component to your Hugo site's config:
+
+```
+[module]
+[[module.imports]]
+path = "github.com/gohugoio/hugo-bootstrap-scss-v4"
+```
+
+The Bootstrap SCSS will be mounted in `assets/scss/bootstrap`, so you can then import either all:
+
+```scss
+@import "bootstrap/bootstrap";
+```
+
+Or only what you need:
+
+
+```scss
+@import "bootstrap/functions";
+@import "bootstrap/variables";
+@import "bootstrap/mixins";
+@import "bootstrap/root";
+@import "bootstrap/reboot";
+@import "bootstrap/type";
+@import "bootstrap/images";
+@import "bootstrap/code";
+@import "bootstrap/grid";
+@import "bootstrap/tables";
+@import "bootstrap/forms";
+@import "bootstrap/buttons";
+@import "bootstrap/transitions";
+@import "bootstrap/dropdown";
+@import "bootstrap/button-group";
+@import "bootstrap/input-group";
+@import "bootstrap/custom-forms";
+@import "bootstrap/nav";
+@import "bootstrap/navbar";
+@import "bootstrap/card";
+@import "bootstrap/breadcrumb";
+@import "bootstrap/pagination";
+@import "bootstrap/badge";
+@import "bootstrap/jumbotron";
+@import "bootstrap/alert";
+@import "bootstrap/progress";
+@import "bootstrap/media";
+@import "bootstrap/list-group";
+@import "bootstrap/close";
+@import "bootstrap/toasts";
+@import "bootstrap/modal";
+@import "bootstrap/tooltip";
+@import "bootstrap/popover";
+@import "bootstrap/carousel";
+@import "bootstrap/spinners";
+@import "bootstrap/utilities";
+@import "bootstrap/print";
+```
\ No newline at end of file
diff --git a/config.toml b/config.toml
index 599cef8..93fa532 100644
--- a/config.toml
+++ b/config.toml
@@ -7,4 +7,4 @@ target = "assets"
 path="github.com/twbs/bootstrap"
 [[module.imports.mounts]]
 source = "scss"
-target = "assets/scss"
\ No newline at end of file
+target = "assets/scss/bootstrap"
\ No newline at end of file
diff --git a/go.mod b/go.mod
index d9eded5..f92c4e4 100644
--- a/go.mod
+++ b/go.mod
@@ -1,3 +1,5 @@
 module github.com/gohugoio/hugo-bootstrap-scss-v4
 
 go 1.13
+
+require github.com/twbs/bootstrap v4.4.1+incompatible // indirect
diff --git a/go.sum b/go.sum
new file mode 100644
index 0000000..cc27772
--- /dev/null
+++ b/go.sum
@@ -0,0 +1,2 @@
+github.com/twbs/bootstrap v4.4.1+incompatible h1:AueNOcQyhFaWJDynY+tJaK1QR+9Dx2CpqW+EoTBUznk=
+github.com/twbs/bootstrap v4.4.1+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=