Skip to content

Commit

Permalink
add info about docker installation to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AMD-NICK committed Dec 27, 2023
1 parent 7ce94f8 commit a9316f3
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docker-image.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
name: Build Docker Image
name: Build Docker Image # source: https://github.com/TRIGONIM/lua-long-polling/blob/main/.github/workflows/docker-image.yml

on:
schedule:
- cron: '37 13 * * 1'
- cron: '37 13 * * 1'
push:
branches: [ "main" ]
tags: [ 'v*.*.*' ]
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ A minimalistic web framework for Lua. High-quality port of [express.js](https://
[![LuaRocks](https://img.shields.io/luarocks/v/AMD-NICK/lua-express)](https://luarocks.org/modules/AMD-NICK/lua-express)
[![License](https://img.shields.io/github/license/TRIGONIM/lua-express)](LICENSE)
[![Repo Size](https://img.shields.io/github/repo-size/TRIGONIM/lua-express)](https://github.com/TRIGONIM/lua-express/archive/refs/heads/master.zip)
[![Docker Image Size](https://img.shields.io/docker/image-size/defaced/lua-express?label=docker%20image)](https://hub.docker.com/r/defaced/lua-express)


```lua
Expand All @@ -23,6 +22,9 @@ app:listen(3000)

```bash
luarocks install lua-express

# or
docker pull ghcr.io/trigonim/lua-express:main
```

## Features:
Expand Down Expand Up @@ -71,13 +73,12 @@ flowchart LR
```bash
luarocks install copas
luarocks install pegasus
# not sure if this is really needed :)
luarocks install luasec

# only for res:json(obj)
# luarocks install lua-cjson

# not sure if this is really needed
# luarocks install luasec

git clone https://github.com/TRIGONIM/lua-express && cd lua-express

# add local module path to LUA_PATH env
Expand Down

0 comments on commit a9316f3

Please sign in to comment.