Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
uvarov-frontend committed Nov 30, 2023
1 parent d65823f commit 517807d
Showing 1 changed file with 16 additions and 11 deletions.
27 changes: 16 additions & 11 deletions package/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,9 @@ To add the necessary styles and scripts, you can use the following code:
// JS Script
import VanillaCalendar from '@uvarov.frontend/vanilla-calendar';

// Basic styles
// Styles
import '@uvarov.frontend/vanilla-calendar/build/vanilla-calendar.min.css';

// Additional styles
import '@uvarov.frontend/vanilla-calendar/build/themes/light.min.css';
import '@uvarov.frontend/vanilla-calendar/build/themes/dark.min.css';

// Initialize the calendar
const calendar = new VanillaCalendar('#calendar');
calendar.init();
Expand All @@ -90,8 +86,6 @@ If you're not using a package manager and prefer manual installation or CDN usag
<head>
<!-- Plugin CSS -->
<link href="./vanilla-calendar.min.css" rel="stylesheet">
<link href="./themes/light.min.css" rel="stylesheet">
<link href="./themes/dark.min.css" rel="stylesheet">
<!-- Plugin JS -->
<script src="./vanilla-calendar.min.js" defer></script>
</head>
Expand All @@ -110,13 +104,24 @@ If you're not using a package manager and prefer manual installation or CDN usag

## CSS Themes

```js
// Only layout calendar
import '@uvarov.frontend/vanilla-calendar/build/vanilla-calendar.layout.min.css';

// Themes
import '@uvarov.frontend/vanilla-calendar/build/themes/light.min.css';
import '@uvarov.frontend/vanilla-calendar/build/themes/dark.min.css';
```

VanillaCalendar includes two CSS themes: the **light theme** and the **dark theme**.

- The **vanilla-calendar.min.css** file contains the essential structural styles for the calendar.
- The **light.min.css** theme provides a light color scheme.
- The **dark.min.css** theme offers a dark color scheme.
- The **vanilla-calendar.min.css** file contains all styles with all themes.
- The **vanilla-calendar.layout.min.css** file contains the essential structural styles for the calendar.
- The **themes/light.min.css** theme provides a light color scheme.
- The **themes/dark.min.css** theme offers a dark color scheme.


The calendar will automatically display the theme based on the user's system preferences. If you want to enforce a specific theme, you can do so manually without the need to import all themes separately.
The calendar will automatically display the theme according to the user's system preferences. If you want to apply a specific theme, it is recommended to import **«vanilla-calendar.layout.min.css»** along with the theme you prefer: **«light.min.css»** or **«dark.min.css»**, instead of **«vanilla-calendar.min.css»**.

## DOM Templates

Expand Down

0 comments on commit 517807d

Please sign in to comment.