Merge pull request #7 from OS2offdig/6-include-links-to-products-usin…

…g-this-template

6 include links to products using this template

README.md

@@ -1,25 +1,34 @@
-# Standard template for documentation in OS2 products
+# Documentation template for OS2 products
 
-This is a *bare-minimum* template to create a [Jekyll] site that:
+![](./image/README/1704965197651.gif)
 
-- uses the [Just the Docs] theme;
-- can be built and published on [GitHub Pages];
-- can be built and previewed locally, and published on other platforms.
+For inspiration, heres some of our pioneers who have adopted this way of building documentation to elevate their products:
+
+- [OS2Compliance](https://github.com/OS2compliance/OS2compliance-docs)
+- [OS2Display](https://github.com/os2display/display-docs)
+
+Feel free to contribute, suggest an issue or submit a pull request with your improvements to this template.
+
+
+## 🏗️ Getting started 
 
+This is a *bare-minimum* template to create a [Jekyll][Jekyll] site that:
+
+- uses the [Just the Docs][Just the Docs] theme;
+- can be built and published on [GitHub Pages][GitHub Pages];
+- can be built and previewed locally, and published on other platforms.
 
 You're free to customize sites that you create with this template, however you like!
 
 [Browse documentation][Just the Docs] to learn more about how to use this theme.
 
 ## Licensing and Attribution
 
-This repository is licensed under the [MIT License]. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use!
+This repository is licensed under the [MIT License][MIT License]. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use!
 
-The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party [starter workflows]. A copy of their MIT License is available in [actions/starter-workflows].
+The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party [starter workflows][starter workflows]. A copy of their MIT License is available in [actions/starter-workflows][actions/starter-workflows].
 
-----
-
-[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).
+---
 
 [Jekyll]: https://jekyllrb.com
 [Just the Docs]: https://just-the-docs.github.io/just-the-docs/
@@ -32,3 +41,4 @@ The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party
 [MIT License]: https://en.wikipedia.org/wiki/MIT_License
 [starter workflows]: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml
 [actions/starter-workflows]: https://github.com/actions/starter-workflows/blob/main/LICENSE
+[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).