ReadMe.md -- Add current build/workflow status and license badge

atsign-foundation / dess

The Distributed Edge Secondary Server (dess) - the self-hosted atServer installer

https://docs.atsign.com

BSD 3-Clause "New" or "Revised" License

9 stars 9 forks source link

ReadMe.md -- Add current build/workflow status and license badge #22

Closed TylerTrott closed 3 years ago

TylerTrott commented 3 years ago

A status badge shows whether a workflow is currently failing or passing. In addition to this, it is important to show our Github BSD 3-clause License badge on all public repositories.

A common place to add the status and license badge is in the README.md at the top alongside the GitHub License.

+ ![example workflow](https://github.com/<OWNER>/<REPOSITORY>/actions/workflows/<WORKFLOW_FILE>/badge.svg)
+ [![GitHub License](https://img.shields.io/badge/license-BSD3-blue.svg)](./LICENSE)

sdesani commented 3 years ago

I was playing around with this one, but does not seem this repo has any actions set up yet. Is that something that will get added on different issue ?

cpswan commented 3 years ago

@sdesani this one just needs a license badge for now.

sdesani commented 3 years ago

Sounds good. Updated the ReadMe and created the PR - https://github.com/atsign-foundation/dess/pull/24 Can you assign this issue to me and review the PR whenever you get a chance ?