Transform README into Markdown

1 files changed, 28 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f2b0af0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Git scripts for the CEFALA's Git server
+
+## Description
+
+The scripts in this directory are intended for use in the git.cefala.org
+server. They are:
+
+* `add-authorized-keys`: Add RSA keys to the authorized_keys file of a given user
+
+* `add-git-repo`: Create a centralized Git repository
+
+* `add-git-user`: Add a Git user to the system  
+
+## Usage
+
+Just type `sudo make` (or `make` as root) to install the scripts. Type
+`sudo uninstall` to uninstall them.
+
+## Credits 
+
+The `git_multimail.py` script was taken from
+https://github.com/git-multimail/git-multimail
+
+## Author
+
+Copyright (C) 2021, 2022 Rafael Laboissière (<rafael@laboissiere.net>)
+
+Released under the GNU Public License, version 3 or later.  No warranties.