First steps to improve README

NixOS · Nov 26, 2020 · 868c978 · 868c978
1 parent 053ef7b
commit 868c978
Showing 1 changed file with 47 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,18 +1,59 @@
-NixOS.org
-=========
+# Source code for nixos.org
 
-This repository contains the sources of the `nixos.org` website.  To
-build it:
+<p align="center">
+  <!-- GitHub Workflow Status of master branch -->
+  <a href="https://github.com/NixOS/nixos-homepage/actions?query=workflow%3A%22Build+%26+Deploy+to+Netlify%22" target="_blank">
+      <img src="https://img.shields.io/github/workflow/status/nixos/nixos-homepage/Build%20&%20Deploy%20to%20Netlify?style=flat-square" alt="GitHub Workflow Status">
+  </a>
+
+  <!-- Number of open GitHub issues -->
+  <a href="https://github.com/nixos/nixos-homepage/issues" target="_blank">
+    <img src="https://img.shields.io/github/issues/nixos/nixos-homepage?style=flat-square&color=red" alt="GitHub issues">
+  </a>
+
+  <!-- Number of open GitHub pull requests -->
+  <a href="https://github.com/nixos/nixos-homepage/pulls" target="_blank">
+    <img src="https://img.shields.io/github/issues-pr/nixos/nixos-homepage?style=flat-square&color=blue" alt="GitHub pull requests">
+  </a>
+
+  <br/>
+
+  <!-- Month of last commit -->
+  <a href="https://github.com/NixOS/nixos-homepage/commits/master" target="_blank">
+    <img src="https://img.shields.io/github/last-commit/NixOS/nixos-homepage?style=flat-square" alt="GitHub last commit">
+  </a>
+
+  <!-- Number of all contributors -->
+  <a href="https://github.com/nixos/nixos-homepage#contribute" target="_blank">
+    <img alt="Contributors" src="https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square">
+  </a>
+
+  <!-- Licenses -->
+  <a href="https://github.com/nixos/nixos/blob/master/LICENSES" target="_blank">
+    <img alt="LICENSE" src="https://img.shields.io/github/license/nixos/nixos-homepage?style=flat-square&color=yellow">
+  </a>
+
+</p>
+
+<hr/>
+
+
+Code and content for [nixos.org](https://nixos.org) website.
+
+
+## Contribute
+
+To run local development instance follow this steps:
 
     $ git clone git@github.com:NixOS/nixos-homepage.git
     $ cd nixos-homepage
     $ nix-shell
     [nix-shell]$ make
     [nix-shell]$ python -m http.server
 
-then open http://127.0.0.1:8000/index.html
+Open your browser at: http://127.0.0.1:8000/index.html
 
-To automatically rebuild on every change:
+To automatically rebuild on every change use:
 
     [nix-shell]$ fd | entr make