Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README.md: add badges at top of page #1623

Merged
merged 2 commits into from
Jul 27, 2023
Merged

README.md: add badges at top of page #1623

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d55a9d5
README.md: add badges for repo and netlify status, releases, license,…
deining Jul 15, 2023
708a726
Drop twitter handle, move badges under page title
deining Jul 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
[![Project status: active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Project releases](https://img.shields.io/github/release/google/docsy)](https://github.com/google/docsy/releases)
[![Project build Status](https://badges.netlify.com/api/docsydocs.svg?branch=master)](https://app.netlify.com/sites/docsydocs/deploys)
[![Project contributors](https://img.shields.io/github/contributors/google/docsy)](https://github.com/google/docsy/graphs/contributors)
[![Project license](https://img.shields.io/github/license/google/docsy)](https://github.com/google/docsy/blob/main/LICENSE)
[![Follow docsy project on Twitter](https://img.shields.io/twitter/follow/docsydocs.svg?style=social)](https://twitter.com/intent/follow?screen_name=docsydocs)

# Docsy

## 🚧 WARNING 🚧 : `main` is under development and potentially unstable! Use official Docsy [releases].
Expand Down Expand Up @@ -81,7 +88,7 @@ npm install
npm run serve
```

## Contributing ![GitHub](https://img.shields.io/github/contributors/google/docsy)
## Contributing

Please read
[CONTRIBUTING.md](https://github.com/google/docsy/blob/main/CONTRIBUTING.md) for
Expand All @@ -90,7 +97,7 @@ us. See also the list of
[contributors](https://github.com/google/docsy/graphs/contributors) who
participated in this project.

## License ![GitHub](https://img.shields.io/github/license/google/docsy)
## License

This project is licensed under the Apache License 2.0 - see the
[LICENSE.md](https://github.com/google/docsy/blob/main/LICENSE) file for details
Expand Down