Merge pull request #3 from kohbis/feature/add_readme

#2 add README
kohbis · Nov 22, 2020 · a51aa90 · a51aa90
2 parents db6886b + 0a13d63
commit a51aa90
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,8 @@
 *.so
 *.dylib
 
+dimg
+
 # Test binary, built with `go test -c`
 *.test
 

diff --git a/README.md b/README.md
@@ -1,5 +1,29 @@
+# dimg
+
+CLI to search and pull images from Docker Hub.
+
+## Download and Install
+
+Download and Install with [Homebrew](https://brew.sh/).
+```bash
+$ brew install kohbis/dimg/dimg
 ```
-brew install kohbis/dimg/dimg
+
+## Usage
+
+```bash
+$ dimg
 ```
 
+You can search image with name and pull specific image with tag.
+
+![console](doc/image/console_library.png)
+
+Default repogitory is official `library`.
+If You want specify repogitory, input Image Name like `${repo_name}/${image_name}`.
+
+![console](doc/image/console_repo_specified.png)
+
+## Appendix
+
 [Docker Advent Calendar 2019 22日目](https://qiita.com/kohbis/items/684b546d9e75e8b2b80b)
diff --git a/doc/image/console_library.png b/doc/image/console_library.png
diff --git a/doc/image/console_repo_specified.png b/doc/image/console_repo_specified.png
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,8 @@ @@
     *.so
     *.dylib
+    dimg
     # Test binary, built with `go test -c`
     *.test
@@ Expand Down @@