diff options
author | Caleb Maclennan <caleb@alerque.com> | 2022-03-24 23:32:57 +0300 |
---|---|---|
committer | Caleb Maclennan <caleb@alerque.com> | 2022-03-25 10:59:23 +0300 |
commit | d3777f9d06df58732e6f87c8fb94efc984652c63 (patch) | |
tree | 6bb58262840f1adc1a406f7b512ac9a9fa4b8399 | |
parent | e8633157298eff538da3cb514cf2e2ad65f45d9c (diff) | |
download | luasocket-d3777f9d06df58732e6f87c8fb94efc984652c63.tar.gz luasocket-d3777f9d06df58732e6f87c8fb94efc984652c63.tar.bz2 luasocket-d3777f9d06df58732e6f87c8fb94efc984652c63.zip |
chore: Start a Markdown era readme
-rw-r--r-- | .github/workflows/build.yml | 2 | ||||
-rw-r--r-- | README | 11 | ||||
-rw-r--r-- | README.md | 12 | ||||
-rw-r--r-- | makefile.dist | 2 |
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 @@ | |||
1 | name: Test build | 1 | name: Build |
2 | 2 | ||
3 | on: | 3 | on: |
4 | push: | 4 | push: |
@@ -1,11 +0,0 @@ | |||
1 | This is the LuaSocket 3.0-rc1. It has been tested on Windows 7, Mac OS X, | ||
2 | and Linux. | ||
3 | |||
4 | Please use the project page at GitHub | ||
5 | |||
6 | https://github.com/lunarmodules/luasocket | ||
7 | |||
8 | to file bug reports or propose changes. | ||
9 | |||
10 | Have fun, | ||
11 | 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 @@ | |||
1 | # LuaSocket | ||
2 | |||
3 | |||
4 | [](https://github.com/lunarmodules/luasocket/actions?workflow=Build) | ||
5 | [](https://github.com/lunarmodules/luasocket/actions?workflow=Luacheck) | ||
6 | [](https://github.com/lunarmodules/luasocket/releases) | ||
7 | [](https://luarocks.org/modules/lunarmodules/luasocket) | ||
8 | |||
9 | LuaSocket is a Lua extension library composed of two parts: | ||
10 | |||
11 | 1. a set of C modules that provide support for the TCP and UDP transport layers, and | ||
12 | 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: | |||
114 | mkdir -p $(DIST) | 114 | mkdir -p $(DIST) |
115 | cp -vf CHANGELOG.md $(DIST) | 115 | cp -vf CHANGELOG.md $(DIST) |
116 | cp -vf LICENSE $(DIST) | 116 | cp -vf LICENSE $(DIST) |
117 | cp -vf README $(DIST) | 117 | cp -vf README.md $(DIST) |
118 | cp -vf $(MAKE) $(DIST) | 118 | cp -vf $(MAKE) $(DIST) |
119 | 119 | ||
120 | mkdir -p $(DIST)/etc | 120 | mkdir -p $(DIST)/etc |