From af4a124728a3d3c3b14593ef91248be134965679 Mon Sep 17 00:00:00 2001
From: axtloss <axtlos@getcryst.al>
Date: Wed, 31 May 2023 20:59:42 +0200
Subject: Improve readme

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index a408811..7a1ea9d 100644
--- a/README.md
+++ b/README.md
@@ -8,3 +8,42 @@ supported/planned features:
 - `jshipit shell` - open a shell in a container
 - `jshipit create` - create a container
 - `jshipit delete` - delete a container
+
+
+## Dependencies
+NOTE: JShipIT only works on linux using the kernel >= 5.11.0
+
+JShipIT requires the following dependencies:
+- Java >= 17
+- unshare
+- bwrap
+- maven
+
+## Building
+```bash
+git clone https://github.com/axtloss/jshipit.git
+cd jshipit
+mvn compile package
+```
+
+## Usage
+
+### Pulling an image
+```bash
+java -jar JavaShipit-1.0-SNAPSHOT-jar-with-dependencies.jar pull -i <image>
+```
+
+### Creating a container
+```bash
+java -jar JavaShipit-1.0-SNAPSHOT-jar-with-dependencies.jar create -i <image> -n <name>
+```
+
+### Running a command in a container
+```bash
+java -jar JavaShipit-1.0-SNAPSHOT-jar-with-dependencies.jar run -n <name> -c <command>
+```
+
+### Opening a shell in a container
+```bash
+java -jar JavaShipit-1.0-SNAPSHOT-jar-with-dependencies.jar shell -n <name>
+```
\ No newline at end of file
-- 
cgit v1.2.3