chore: Start a Markdown era readme

4 files changed, 14 insertions, 13 deletions

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 17cad49..d6fe214 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -1,4 +1,4 @@
-name: Test build
+name: Build
 
 on:
   push:
diff --git a/README b/README
deleted file mode 100644
index 7354ea0..0000000
--- a/README
+++ /dev/null
@@ -1,11 +0,0 @@
-This is the LuaSocket 3.0-rc1. It has been tested on Windows 7, Mac OS X,
-and Linux.
-
-Please use the project page at GitHub
-
-    https://github.com/lunarmodules/luasocket
-
-to file bug reports or propose changes.
-
-Have fun,
-Diego Nehab.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..af722be
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# LuaSocket
+
+
+[![Build](https://img.shields.io/github/workflow/status/lunarmodules/luasocket/Build?label=Build=Lua)](https://github.com/lunarmodules/luasocket/actions?workflow=Build)
+[![Luacheck](https://img.shields.io/github/workflow/status/lunarmodules/luasocket/Luacheck?label=Luacheck&logo=Lua)](https://github.com/lunarmodules/luasocket/actions?workflow=Luacheck)
+[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/lunarmodules/luasocket?label=Tag&logo=GitHub)](https://github.com/lunarmodules/luasocket/releases)
+[![Luarocks](https://img.shields.io/luarocks/v/lunarmodules/luasocket?label=Luarocks&logo=Lua)](https://luarocks.org/modules/lunarmodules/luasocket)
+
+LuaSocket is a Lua extension library composed of two parts:
+
+1. a set of C modules that provide support for the TCP and UDP transport layers, and
+2. a set of Lua modules that provide functions commonly needed by applications that deal with the Internet.
diff --git a/makefile.dist b/makefile.dist
index 34914c3..3a2e100 100644
--- a/makefile.dist
+++ b/makefile.dist
@@ -114,7 +114,7 @@ dist:
         mkdir -p $(DIST)
         cp -vf CHANGELOG.md $(DIST)
         cp -vf LICENSE $(DIST)
-        cp -vf README $(DIST)
+        cp -vf README.md $(DIST)
         cp -vf $(MAKE) $(DIST)
 
         mkdir -p $(DIST)/etc