Skip to content

Commit

Permalink
chore: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
firejune committed Nov 8, 2023
1 parent 477f2a1 commit fd23404
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
## Notion Github Embed
## Jandee

This is a simple project that lets you embed a GitHub user's contribution chart in a Notion document.
Jandee is a simple project that lets you embed a GitHub user's contribution calendar into any document.

### How to use this?
### How to use This in Notion?

1. Create a new Embed block in your Notion doc.
1. Create a new Embed block in your any document.
2. Set the Embed URL to `https://jandee.vercel.app/%USERNAME%` replacing `%USERNAME%` with your GitHub username.
3. Adjust the size of the embed accordingly.
4. Bask in its glory!

![glory](https://i.imgur.com/aU95o4N.png)

#### How to change color mode
### How to change color mode

You can change the color using the `scheme` parameter. Values include `light` and `dark`. If the parameter is not used, it is automatically selected by the system.

```
https://jandee.vercel.app/%USERNAME%?scheme=dark
```

#### How to change time zone
### Can I change the Time Zone?

You can set the timezone.
Yes, You can set the specific Time Zone. If the Time Zone is not set, it operates as UTC+0.

```
https://jandee.vercel.app/%USERNAME%?tz=America/New_York
```

#### How to change style
### How to customize chart style?

You can change the style of your graph. Supported properties include:

Expand All @@ -40,15 +40,15 @@ You can change the style of your graph. Supported properties include:
https://jandee.vercel.app/%USERNAME%?redias=3&margin=2&footer=false&weeks=false
```

#### How to export to PNG image
### How to export to PNG image

Basically, charts are created using SVG image. You can use PNG as an alternative. However, PNG images may have slightly different fonts.
You can use Canvas with Embed method as an alternative. This Canvas can be saved as PNG images with transparency. However, depending on the system, the font shape or size may vary slightly.

```
https://jandee.vercel.app/%USERNAME%/canvas
```

#### Credit
### Credit

This project was inspired by the following project::

Expand Down

0 comments on commit fd23404

Please sign in to comment.