Change file name readme.md to README.md. Add more content to README.
This adds a high level description of the project, including background
information, technologies used and instructions on how to use.
Signed-off-by: Simon-Lii <thesimonli@google.com>
Change-Id: I50b07f2e062d231a71855bd01347b38750730cbe
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b0507b1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# openbmc cloudbuild ci
+
+This application provides the scripts and configuration files to Google
+Cloudbuild, a CI pipeline on Google Cloud Platform that performs builds.
+GCB's purpose is to build openbmc image releases.
+
+## Technologies
+
+Python is the main language used. With Python, it is possible to perform shell
+scripting whilst leveraging Python's Object Oriented Programming capabilities.
+This allows for unit tests to be integrated very easily, allowing for better
+code maintainability.
+
+Different Docker containers are used to perform tasks that require a
+specific environment. These Docker images are stored on Google Cloud Registry.
+
+Artifacts left by the build are stored on Google Cloud Storage.
+
+This application is configurable through substitution variables (environment
+variables) on Google Cloudbuild's User Interface.
+
+## Instructions
+
+The detailed instructions for this project can be found [here](https://docs.google.com/document/d/19c7deQe1MJQ4rhJo-HrbsSOXnWKxSuazoaGwZcdQups/edit?usp=sharing&resourcekey=0-cqxnk73pGtaf1po8SZYctg)
+
+In summary, to perform a build, the user runs a manual trigger. This trigger is
+setup in advance.
+
+The trigger setups up the following:
+* Connects to this project's repository
+* Sets up the substitution variables
+* Sets the yaml configuration file name
+
+The user can run at most 10 builds at the same time.
+
+The artifacts for the builds are located in Google Cloud Storage in the
+appropriate bucket setup in advance.
+
+An example GCS url: gs://my-release-bucket/my-machine/my-version/
diff --git a/readme.md b/readme.md
deleted file mode 100644
index e52d4a8..0000000
--- a/readme.md
+++ /dev/null
@@ -1 +0,0 @@
-openbmc cloudbuild ci
