summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJakub Hrozek <jhrozek@redhat.com>2017-02-24 09:22:20 +0100
committerLukas Slebodnik <lslebodn@redhat.com>2017-02-27 14:06:50 +0100
commiteed5bc53a0c823276523d32e76bc1c264db3837e (patch)
tree9dcc3ba5d0e7c18c25eef93e77b9874993f08595 /README.md
parent1b55ac98db6a319d45edae6c27ff3804f1f4d28a (diff)
downloadsssd-eed5bc53a0c823276523d32e76bc1c264db3837e.tar.gz
sssd-eed5bc53a0c823276523d32e76bc1c264db3837e.tar.xz
sssd-eed5bc53a0c823276523d32e76bc1c264db3837e.zip
DOC: Deprecate README, add README.md
To make it easier to display the contents of README on the project homepage, this patch converts the README contents to README.md. The original README is removed so that we don't maintain two different sources. The links to fedorahosted are retained until we migrate the wiki pages. Reviewed-by: Lukáš Slebodník <lslebodn@redhat.com> Reviewed-by: Fabiano Fidêncio <fidencio@redhat.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..40c88c080
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# SSSD - System Security Services Daemon
+
+## Introduction
+SSSD provides a set of daemons to manage access to remote directories and
+authentication mechanisms such as LDAP, Kerberos or FreeIPA. It provides
+an NSS and PAM interface toward the system and a pluggable backend system
+to connect to multiple different account sources.
+
+More information about SSSD can be found on its project page -
+https://pagure.io/SSSD/sssd/
+
+## Building and installation
+Please see the file BUILD.txt for details
+
+## Documentation
+The most up-to-date documentation can be found at https://fedorahosted.org/sssd/wiki/Documentation
+
+## Licensing
+Please see the file called COPYING.
+
+## Contacts
+There are several ways to contact us:
+
+* the sssd-devel mailing list: [Development of the System Security Services Daemon](https://fedorahosted.org/mailman/listinfo/sssd-devel)
+* the sssd-users mailing list: [End-user discussions about the System Security Services Daemon](https://fedorahosted.org/mailman/listinfo/sssd-users)
+* the #sssd and #freeipa IRC channels on freenode:
+ * irc://irc.freenode.net/sssd
+ * irc://irc.freenode.net/freeipa