Skip to content

Commit

Permalink
fix: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dlcastillop committed Mar 19, 2023
1 parent 5b669cf commit 06006ad
Showing 1 changed file with 50 additions and 4 deletions.
54 changes: 50 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,9 @@ You can modify the theme in the `theme` property. It accepts 33 values:

For example:

```js
"theme": "minimalist-dark-theme",
```

### Hero section

Expand All @@ -74,19 +76,22 @@ The Hero section is going to have your photo, name and description. You can modi

For example:

```js
"properties": {
"name": "Daniel Castillo",
"description": "Frontend web developer",
"alt": "Photo of Daniel Castillo",
"hero": "./src/images/daniel-castillo.png"
},
```

### Social media section

The Social Media section is going to have all your social media links. You can modify it in the `Social` array which has one object per social media. You only need to put your social media link in the `link` property within the corresponding object.

For example:

```js
"Social": [
{
"label": "Email",
Expand Down Expand Up @@ -128,11 +133,13 @@ For example:
{ "label": "Product Hunt", "value": "bxl-product-hunt", "link": "" },
{ "label": "Newsletter", "value": "bx-mail-send", "link": "" }
],
```

If you want to modify the order of the social media, you must organize the objects according to your preference.

For example:

```js
"Social": [
{ "label": "LinkedIn", "value": "bxl-linkedin", "link": "https://linkedin.com/in/dlcastillop" },
{ "label": "Twitter", "value": "bxl-twitter", "link": "https://twitter.com/dlcastillop" },
Expand All @@ -154,15 +161,36 @@ For example:
{ "label": "Product Hunt", "value": "bxl-product-hunt", "link": "" },
{ "label": "Newsletter", "value": "bx-mail-send", "link": "" }
],

The Social Media section supports Twitter, GitHub, LinkedIn, Instagram, a link, Discord, Facebook, Medium, Pinterest, Snapchat, Telegram, TikTok, Twitch, Vimeo, WhatsApp, YouTube, Product Hunt and a newsletter.
```

The Social Media section supports:

- Twitter
- GitHub
- LinkedIn
- Instagram
- A link
- Discord
- Facebook
- Medium
- Pinterest
- Snapchat
- Telegram
- TikTok
- Twitch
- Vimeo
- WhatsApp
- YouTube
- Product Hunt
- A newsletter

### Payment section

The Payment section is going to have all your payment methods. You can modify it in the `Payments` array which has one object per payment methods. You only need to put your payment method link in the `value` property within the corresponding object.

For example:

```js
"Payments": [
{
"id": "btc",
Expand Down Expand Up @@ -249,11 +277,13 @@ For example:
"img": "./images/payments/card.svg"
}
]
```

If you want to modify the order of the payment methods, you must organize the objects according to your preference.

For example:

```js
"Payments": [
{
"id": "qvapay",
Expand Down Expand Up @@ -340,8 +370,24 @@ For example:
"img": "./images/payments/card.svg"
}
]

The Payment section supports Bitcoin, Binance USD, Matic, DogeCoin, Ethereum, Litecoin, PayPal, USDT, QvaPay, Solana, ADA, TRON, XRP and a card.
```

The Payment section supports:

- Bitcoin
- Binance USD
- Matic
- DogeCoin
- Ethereum
- Litecoin
- PayPal
- USDT
- QvaPay
- Solana
- ADA
- TRON
- XRP
- A card

## How to deploy

Expand Down

0 comments on commit 06006ad

Please sign in to comment.