Usage and Notes

Author: termoshtt

README.md

@@ -1,7 +1,33 @@
 rust-mkl container
 ===================
 
-Container for building Rust crate with Intel MKL.
+Container for building Rust crate with Intel MKL,
+and helping to develop [intel-mkl-src](https://github.com/rust-math/intel-mkl-src) crate.
+
+Usage
+-----
+
+- With docker:
+
+  ```
+  docker pull ghcr.io/rust-math/rust-mkl:1.62.1-2020.1
+  ```
+
+- In GitHub Actions:
+  ```
+  runs-on: ubuntu-latest
+  container:
+    image: ghcr.io/rust-math/rust-mkl:1.62.1-2020.1
+  ```
+  See [`jobs.<job_id>.container`](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idcontainer) section of the workflow syntax.
+
+⚠️ Notes
+--------
+
+- You should not use `latest` tag
+  - I strongly encourage you not to use `latest` tag for any image and in any situation.
+- This is designed to use for development, i.e. build and test of crates.
+  Do not use as a base of production container.
 
 License
 --------