diff --git a/README b/README.md similarity index 78% rename from README rename to README.md index 9d37a4e..40f21ab 100644 --- a/README +++ b/README.md @@ -1,23 +1,22 @@ -LuaFileSystem - File System Library for Lua +# LuaFileSystem - File System Library for Lua Copyright 2003-2015 Kepler Project http://keplerproject.github.io/luafilesystem -Description ------------ +# Description + LuaFileSystem is a Lua library developed to complement the set of functions related to file systems offered by the standard Lua distribution. LuaFileSystem offers a portable way to access the underlying directory structure and file attributes. LuaFileSystem is free software and uses the same license as Lua 5.1 -LuaRocks Installation ---------------------- +# LuaRocks Installation ``` luarocks install luafilesystem ``` -Documentation -------------- +# Documentation + Please check the documentation at doc/us/ for more information.