mirror of
https://github.com/dilllxd/gitfolio.git
synced 2024-08-14 22:28:09 +00:00
Update README.md
This commit is contained in:
parent
39f9053456
commit
d07c6fc7af
1 changed files with 7 additions and 27 deletions
34
README.md
34
README.md
|
@ -1,32 +1,12 @@
|
||||||
# gitfolio
|
### about.me + medium but for every github User
|
||||||
portfolio website that showcases your work
|
|
||||||
|
Gitfolio will help you up and running with a portfolio website where you could showcase your work + a blog that will help you spread your ideas in real world.
|
||||||
|
|
||||||
|
|
||||||
# Getting Started
|
# Getting Started
|
||||||
|
|
||||||
First of all you need to fork this repo as "your_username.github.io"
|
### Fork this repo
|
||||||
|
|
||||||
```
|
|
||||||
$ git clone "your repo you just forked"
|
|
||||||
$ cd "your repo name"
|
|
||||||
$ npm i
|
|
||||||
```
|
|
||||||
|
|
||||||
# Building
|
## License
|
||||||
|
GNU General Public License v3.0
|
||||||
```
|
|
||||||
$ node build --name "your_username"
|
|
||||||
```
|
|
||||||
|
|
||||||
# Customizing
|
|
||||||
|
|
||||||
To add your background image
|
|
||||||
|
|
||||||
```
|
|
||||||
$ node build --name "your github username" --background "background url"
|
|
||||||
```
|
|
||||||
|
|
||||||
To enable Dark theme
|
|
||||||
|
|
||||||
```
|
|
||||||
$ node build --name "your github username" --dark
|
|
||||||
```
|
|
||||||
|
|
Loading…
Reference in a new issue