From 021588157748556e2229e8c6a729c91fb608988b Mon Sep 17 00:00:00 2001
From: jelemux <jeremias.weber@protonmail.com>
Date: Thu, 4 Feb 2021 18:18:24 +0100
Subject: fix some issues and add readme

---
 Readme.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 Readme.md

(limited to 'Readme.md')

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..ca02f40
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,53 @@
+<div align="center">
+
+  <h1><code>wasmCard</code></h1>
+  <strong>An Online vCard Generator written in Rust.</strong>
+
+</div>
+
+## 📚 About
+
+A WebAssebmly Web App
+
+Supports generating vCards (.vcf), print-ready PDF business cards and QR Codes.
+
+## 🎮 Features
+
+* Supported properties as of yet: name, address, telephone
+* Output and Download as vCard (.vcf)
+* Output and Download as QR Code
+* Generates a dummy PDF
+
+## 🗺 Roadmap
+
+* Add more properties
+* Button for adding more of one type of property (Support is already there)
+* Put generation and download both in download button
+* Generate PDF
+
+## 🚲 Usage
+
+### 🛠️ Needed tools
+
+* [Standard rust toolchain](https://www.rust-lang.org/tools/install)
+* [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/)
+* HTTP Server (python has one!)
+
+
+### 📦 Build with `wasm-pack build`
+
+```
+wasm-pack build --target web
+```
+
+### 🔍 Use the debug flag for tracing errors
+
+```
+wasm-pack build --debug --target web
+```
+
+### 🎬 Run on python server
+
+```
+python -m http.server 8000
+```
\ No newline at end of file
-- 
cgit v1.2.3