Skip to content

Commit

Permalink
Add Additional Readme Sections (#74)
Browse files Browse the repository at this point in the history
* Add demo screenshot

* references

* add copyrights

* Use https
  • Loading branch information
osterman authored Jul 6, 2018
1 parent b89251b commit 6526365
Show file tree
Hide file tree
Showing 4 changed files with 72 additions and 4 deletions.
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ It's 100% Open Source and licensed under the [APACHE2](LICENSE).



## Screenshots


![demo](https://cdn.rawgit.com/cloudposse/build-harness/master/docs/demo.svg)
*Example of using the `build-harness` to build a docker image*


## Usage

At the top of your `Makefile` add, the following...
Expand Down Expand Up @@ -144,6 +151,15 @@ Check out these related projects.
- [Dev Harness](https://github.com/cloudposse/dev) - Cloud Posse Local Development Harness
## References
For additional context, refer to some of these links.
- [Wikipedia - Test Harness](https://en.wikipedia.org/wiki/Test_harness) - The `build-harness` is similar in concept to a "Test Harness"
## Help
**Got a question?**
Expand Down Expand Up @@ -191,9 +207,14 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
## Copyright
Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com)
## Copyrights
Copyright © 2016-2018 [Cloud Posse, LLC](https://cloudposse.com)
## License
Expand Down
18 changes: 18 additions & 0 deletions README.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ name: Build Harness
# License of this project
license: "APACHE2"

# Copyrights
copyrights:
- name: "Cloud Posse, LLC"
url: "https://cloudposse.com"
year: "2016"

# Canonical GitHub repo
github_repo: cloudposse/build-harness

Expand All @@ -35,6 +41,18 @@ related:
- name: "Dev Harness"
description: "Cloud Posse Local Development Harness"
url: "https://github.com/cloudposse/dev"

# References
references:
- name: "Wikipedia - Test Harness"
description: 'The `build-harness` is similar in concept to a "Test Harness"'
url: "https://en.wikipedia.org/wiki/Test_harness"

# Screenshots
screenshots:
- name: "demo"
description: "Example of using the `build-harness` to build a docker image"
url: "https://cdn.rawgit.com/cloudposse/build-harness/master/docs/demo.svg"

# Short description of this project
description: |-
Expand Down
5 changes: 5 additions & 0 deletions docs/demo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 26 additions & 2 deletions templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,15 @@ It's 100% Open Source and licensed under the [APACHE2](LICENSE).
{{ if eq (ds "config").license "CC-BY-NC-SA-4.0" }}
It's 100% Open Source and licensed under the [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](LICENSE).

<a href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img title="Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License" src="static/images/cc-by-nc-sa.png" width="150" /></a>
<a href="https://creativecommons.org/licenses/by-nc-sa/4.0/"><img title="Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License" src="static/images/cc-by-nc-sa.png" width="150" /></a>
{{ end }}

{{ if has (ds "config") "screenshots" }}
## Screenshots

{{ range $screenshot := (ds "config").screenshots }}
{{ printf "![%s](%s)\n*%s*" $screenshot.name $screenshot.url $screenshot.description }}{{ end }}
{{ end }}
{{ if has (ds "config") "usage" }}
## Usage

Expand Down Expand Up @@ -56,6 +62,15 @@ Check out these related projects.
{{ range $related := (ds "config").related }}
{{ printf "- [%s](%s) - %s" $related.name $related.url $related.description }}{{ end }}

{{ end}}
{{ if has (ds "config") "references" }}

## References

For additional context, refer to some of these links.
{{ range $reference := (ds "config").references }}
{{ printf "- [%s](%s) - %s" $reference.name $reference.url $reference.description }}{{ end }}

{{ end}}
## Help

Expand Down Expand Up @@ -104,9 +119,18 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!

{{ if has (ds "config") "copyrights" }}

## Copyrights

{{ range $copyright := (ds "config").copyrights -}}
{{ printf "Copyright © %s-%d [%s](%s)\n" $copyright.year time.Now.Year $copyright.name $copyright.url }}
{{ end }}
{{ else }}
## Copyright

Copyright © 2017-{{ time.Now.Year }} [Cloud Posse, LLC](https://cloudposse.com)
{{ end}}

{{ if eq (ds "config").license "APACHE2" }}
## License
Expand Down Expand Up @@ -139,7 +163,7 @@ See [LICENSE](LICENSE) for full details.

<a href="https://creativecommons.org/licenses/by-nc-sa/4.0/"><img title="Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License" src="https://docs.cloudposse.com/images/cc-by-nc-sa.png" width="150" /></a>

This material may only be distributed subject to the terms and conditions set forth in the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License or later with the restrictions noted below (the latest version of the license is presently available at <http://creativecommons.org/licenses/by-nc-sa/4.0/>).
This material may only be distributed subject to the terms and conditions set forth in the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License or later with the restrictions noted below (the latest version of the license is presently available at <https://creativecommons.org/licenses/by-nc-sa/4.0/>).

**Attribution** You must attribute the work in the manner specified by the author or licensor.

Expand Down

0 comments on commit 6526365

Please sign in to comment.