chore: update readme (#34)

LuciNyan · May 2, 2024 · e595400 · e595400
1 parent b794e29
commit e595400
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -57,7 +57,7 @@ The `dithering=true` configuration is a standalone setting that can be applied t
 
 ![Journey](./packages/pixel-profile/test/__image_snapshots__/theme-test-ts-packages-pixel-profile-test-theme-test-ts-theme-render-card-with-journey-theme-and-dithering-1-snap.png)
 ```html
-https://pixel-profile.vercel.app/api/github-stats?username=<username>&theme=journey&pixelate_avatar=false&dithering=true
+https://pixel-profile.vercel.app/api/github-stats?username=<username>&theme=journey&dithering=true&hide=avatar
 ```
 
 #### 2. Road trip without pixelated avatar.
@@ -109,6 +109,7 @@ https://pixel-profile.vercel.app/api/github-stats?username=<username>&theme=lax
 | `screen_effect`       | Enable curved screen effect                                                                                                                           | `false`       |
 | `username`            | GitHub username                                                                                                                                       | ''            |
 | `theme`               | Check out the built-in themes below                                                                                                                   | ''            |
+| `dithering`           | Rendered the image using a 256-color palette with dithering                                                                                           | `false`       |
 
 
 ### Hiding individual stats

diff --git a/...est-theme-test-ts-theme-render-card-with-journey-theme-and-dithering-1-snap.png b/...est-theme-test-ts-theme-render-card-with-journey-theme-and-dithering-1-snap.png
diff --git a/packages/pixel-profile/test/theme.test.ts b/packages/pixel-profile/test/theme.test.ts
@@ -56,7 +56,7 @@ describe('Theme', () => {
   it('Render card with journey theme and dithering', async () => {
     const png = await renderStats(
       { ...stats, avatarUrl: DARK_GREEN_AVATAR },
-      { theme: 'journey', pixelateAvatar: false, dithering: true }
+      { theme: 'journey', pixelateAvatar: false, dithering: true, hiddenStatsKeys: ['avatar'] }
     )
     expect(png).toMatchImageSnapshot()
   })