docs: readme updated

README.md

@@ -1,32 +1,52 @@
 <p align="center">
     <img width="500" src="https://i.imgur.com/coa1q5T.png" alt="logo">
 </p>
+
 <p align="center">
-<a href="https://www.npmjs.com/package/ulka">
-<img alt="NPM" src="https://img.shields.io/npm/v/ulka?&labelColor=black&color=darkred&logo=npm&label=npm" />
-</a>&nbsp;
-<a href="https://github.com/acharyaroshanji/ulka">
-<img alt="MIT" src="https://img.shields.io/npm/l/ulka?color=darkgreen&labelColor=black&&logo=github" />
-</a>&nbsp;
-<a href="#"><img alt="CI" src="https://github.com/ulkajs/ulka/workflows/CI/badge.svg"></a>
+A simpler static site generator written in JavaScript to transform ulka and markdown files to html.
 </p>
 
 <p align="center">
-    Ulka is a free and open source static site generator that helps you create static sites from markdown and ulka files.
+<a href="https://www.npmjs.com/package/ulka"><img alt="NPM" src="https://img.shields.io/npm/v/ulka?&labelColor=black&color=darkred&logo=npm&label=npm" /></a>&nbsp;
+<a href="https://github.com/acharyaroshanji/ulka"><img alt="MIT" src="https://img.shields.io/npm/l/ulka?color=darkgreen&labelColor=black&&logo=github" /></a>&nbsp;
+<a href="https://github.com/prettier/prettier"><img alt="Prettuer" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?color=b3095d&labelColor=black&logo=prettier"></a>&nbsp;
+<a href="#"><img alt="CI" src="https://img.shields.io/github/workflow/status/ulkajs/ulka/CI?color=darkgreen&label=CI&logo=github&labelColor=black"></a>&nbsp;
+<a href="https://gatsbyjs.org/contributing/how-to-contribute/"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?labelColor=black&logo=github&color=darkgreen" alt="PRs welcome!" /></a>
+
 </p>
+<br />
 
-## 🚀 Quick start
+## 🚀 Getting Started
 
 1. Create new ulka site
 
-   ```
+   ```bash
    npx ulka create <app-name> <template_url> -i npm
+
+   ## OR
+
+   npm i -g ulka
+   ulka create <app-name> <template_url> -i npm
    ```
 
-2. Navigate to app name and start server
+2. Navigate to app name and start dev server
    ```
    cd <app-name>
-   npm start
+   npm run develop
    ```
 
-Complete documentation comming soon....
+## 📖 Documentation
+
+Coming soon...
+
+## 🤗 Contributing
+
+We welcome you to join the development of Ulka. Please see [Contributing](https://github.com/ulkajs/ulka/blob/master/CONTRIBUTING.md) Guidelines.
+
+## LICENSE
+
+<a href="https://github.com/nuxt/nuxt.js/blob/dev/LICENSE">MIT</a>
+
+---
+
+<a href="https://www.buymeacoffee.com/coderosh" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" width="200" alt="Buy Me A Coffee"></a>

package.json

@@ -1,7 +1,7 @@
 {
   "name": "ulka",
   "version": "0.6.1",
-  "description": "Ulka - static site generator",
+  "description": "Ulka - A simpler static site generator written in JavaScript",
   "main": "./src/index.js",
   "bin": {
     "ulka": "./bin/index.js"
@@ -26,7 +26,9 @@
     "website",
     "jekyll",
     "blog",
-    "ssg"
+    "ssg",
+    "gatsby",
+    "11ty"
   ],
   "author": "Roshan Acharya",
   "license": "MIT",

src/index.js

@@ -1,8 +1,10 @@
 const { generateHash, getConfigs } = require("./utils/helpers")
 const log = require("./utils/ulka-log")
+const ulkaFs = require("./utils/ulka-fs")
 
 module.exports = {
   generateHash,
   getConfigs,
-  log
+  log,
+  ulkaFs
 }

tests/unit/index.test.js

@@ -10,6 +10,11 @@ test("Should exported the expected value", () => {
         "success": [Function],
         "warning": [Function],
       },
+      "ulkaFs": Object {
+        "allFiles": [Function],
+        "mkdir": [Function],
+        "rmdir": [Function],
+      },
     }
   `)
 })