diff --git a/README.md b/README.md index 3eb4e78..fe8bdc1 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,11 @@ ### personal website + blog for every github user -Gitfolio will help you get started with a portfolio website where you could showcase your work + a blog that will help you spread your ideas into real world. +Gitfolio will help you get started with a portfolio website where you could showcase your work + a blog that will help you spread your ideas into real world. Check out this [live demo](https://imfunniee.github.io/gitfolio/) to see gitfolio in action. + # Getting Started ### Let's Build @@ -38,7 +39,31 @@ d. To run your website navigate to `./dist/index.html` in your browser. [you won ### Let's Customize -#### Enabling Themes +#### Forks + +To include forks on your personal website just provide `-f` or `--fork` argument while building + +``` +$ node build --name username -f +``` + +#### Sorting Repos + +To sort repos provide `--sort [sortBy]` argument while building. Where `[sort]` can be `created`, `updated`, `pushed`,`full_name`. Default: `created` + +``` +$ node build --name username --sort created +``` + +#### Ordering Repos + +To order the sorted repos provide `--order [orderBy]` argument while building. Where `[orderBy]` can be `asc` or `desc`. Default: `asc` + +``` +$ node build --name username --sort created --order desc +``` + +#### Customize Themes Themes are specified using the `--theme [theme-name]` flag when running the `build` command. The available themes are diff --git a/build.js b/build.js index 0186921..f84e4b7 100644 --- a/build.js +++ b/build.js @@ -73,7 +73,7 @@ async function populateCSS() { populateCSS(); if (program.name) { - let sort = program.sort ? program.sort : 'created_at'; + let sort = program.sort ? program.sort : 'created'; let order = -1; let includeFork = false;