Skip to content

Commit ad57d8a

Browse files
committed
chore: Update package.json and README.md
1 parent 6cb30ab commit ad57d8a

4 files changed

Lines changed: 1359 additions & 6 deletions

File tree

README.md

Lines changed: 100 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,100 @@
1-
# modulatecss
1+
# Modulate CSS
2+
3+
The `modulatecss` package is designed to distribute ModulateCSS styles, providing a streamlined and scalable solution for modern web development. It allows developers to integrate a comprehensive CSS framework that enhances design consistency, maintainability, and responsiveness across web applications. This package supports both CDN and npm installation methods, making it versatile for different project setups. ModulateCSS leverages advanced CSS techniques such as Grid, Flexbox, and CSS custom properties, ensuring your web designs are robust and future-proof.
4+
5+
Read the docs under [https://modulatecss.com/](https://modulatecss.com/).
6+
7+
## Features
8+
- **Comprehensive Style Distribution:** Ensures consistent styling across your web projects.
9+
- **Advanced CSS Techniques:** Utilizes modern CSS features like Grid, Flexbox, and custom properties.
10+
- **Flexible Integration:** Supports installation via CDN or npm, adaptable to various project needs.
11+
- **Scalable and Maintainable:** Promotes a clear separation of concerns and modular CSS structure for easier maintenance.
12+
- **Responsive Design:** Implements fluid sizing and other responsive techniques to adapt seamlessly across devices.
13+
14+
## Installation
15+
You can install `modulatecss` using npm:
16+
17+
```bash
18+
npm install -D modulatecss
19+
```
20+
21+
Or include it directly via CDN:
22+
23+
```html
24+
<link href="https://cdn.jsdelivr.net/npm/modulate@1.0.0/dist/css/modulate.min.css" rel="stylesheet">
25+
```
26+
27+
## Integration
28+
**Next.js:**
29+
30+
```javascript
31+
import 'modulate.css';
32+
import '@styles/theme.css';
33+
34+
function MyApp({ Component, pageProps }) {
35+
return <Component {...pageProps} />;
36+
}
37+
38+
export default MyApp;
39+
```
40+
41+
**Angular:**
42+
43+
```json
44+
{
45+
"projects": {
46+
"your-project-name": {
47+
"architect": {
48+
"build": {
49+
"options": {
50+
"styles": [
51+
"node_modules/modulate.css/modulate.css",
52+
"styles/theme.css"
53+
]
54+
}
55+
}
56+
}
57+
}
58+
}
59+
}
60+
```
61+
62+
**Vue.js:**
63+
64+
```javascript
65+
import 'modulate.css';
66+
import 'styles/theme.css';
67+
68+
new Vue({
69+
render: h => h(App),
70+
}).$mount('#app');
71+
```
72+
73+
**Svelte:**
74+
75+
```javascript
76+
import 'modulate.css';
77+
import 'styles/theme.css';
78+
79+
const app = new App({
80+
target: document.body,
81+
});
82+
83+
export default app;
84+
```
85+
86+
**Gatsby:**
87+
88+
```javascript
89+
import 'modulate.css';
90+
import 'styles/theme.css';
91+
```
92+
93+
## Repository
94+
For more information, visit the [GitHub repository](https://github.com/byteyard/modulatecss).
95+
96+
## Issues
97+
To report bugs or request features, please use the [issue tracker](https://github.com/byteyard/modulatecss/issues).
98+
99+
## License
100+
This project is licensed under MIT.

0 commit comments

Comments
 (0)