From 7955dd59f5e993725cbd528cde1387793d50e61b Mon Sep 17 00:00:00 2001
From: Marcel Metz <mmetz@adrian-broher.net>
Date: Wed, 6 Feb 2013 12:03:24 +0100
Subject: [PATCH] Extended the README file.

---
 README    |  1 -
 README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 66 insertions(+), 1 deletion(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index 01a8d2e..0000000
--- a/README
+++ /dev/null
@@ -1 +0,0 @@
-Gnome Shell Extension that adds an applet on the panel which reveals current CPU temperature in Degree Celsius and Fahrenheit.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..14f9699
--- /dev/null
+++ b/README.md
@@ -0,0 +1,66 @@
+gnome-shell-extension-cpu-temperature
+=====================================
+
+*gnome-shell-extension-cpu-temperature* is a extension for displaying
+system temperature data in GNOME Shell. The temperature data are
+provided by [lm_sensors] and optionally by [hddtemp].
+
+----
+
+Dependencies
+------------
+
+This extension requires:
+
+* [lm_sensors] to read CPU and motherboard temperature data.
+
+Optionally this extension uses:
+
+* [hddtemp] to read hard drive temperature data.
+
+Installation
+------------
+
+You can install this extension by visiting the [GNOME extensions]
+homepage.
+
+Installation by package manager
+-------------------------------
+
+Fedora has packaged this extension. You can install it by running:
+
+`yum -y install gnome-shell-extension-cpu-temperature`
+
+Manual installation
+-------------------
+
+If you prefer a manual installation you can install this extension
+for your user by executing:
+
+    cd ~/.local/share/gnome-shell/extensions
+    git clone https://github.com/xtranophilist/gnome-shell-extension-cpu-temperature.git temperature@xtranophilist
+
+or system wide by excuting (this requires root permissions):
+
+    cd /usr/share/gnome-shell/extensions/
+    git clone https://github.com/xtranophilist/gnome-shell-extension-cpu-temperature.git temperature@xtranophilist
+
+After installation you need to restart the GNOME shell by:
+
+* `ALT`+`F2` to open the command prompt
+* Enter `r` to restart the GNOME shell
+
+Configuration
+-------------
+
+This extensions uses the output `sensors`(1) command to obstain the
+temperature data and sensor labeling. To relabel, hide or correct the
+output consult the `sensors.conf`(5) manual.
+
+Authors
+-------
+* Dipesh Acharya <xtranophilist@gmail.com>
+
+[lm_sensors]: http://www.lm-sensors.org/
+[hddtemp]: https://savannah.nongnu.org/projects/hddtemp/
+[GNOME extensions]: https://extensions.gnome.org/extension/82/cpu-temperature-indicator/