terminal.css/README.md
2019-10-07 09:34:44 +02:00

48 lines
1.2 KiB
Markdown

# Terminal CSS
Modern and minimal CSS framework for terminal lovers.
Visit the website [terminalcss.xyz](https://terminalcss.xyz/)
## Project Goals
Terminal CSS has no overhead and is lightweight **(~3k gzip)**.
The source is written in **pure css** to be accessible for everybody and easy to contribute.
## Markdown ❤️ Terminal CSS
It's perfect for your *personal website*, *blog*, or *side project*.
## How to use
When using something like Webpack just install with `npm i terminal.css`.
```js
import 'terminal.css'
```
Terminal CSS is also available via [CDN](https://unpkg.com/terminal.css@0.7.1/dist/terminal.min.css)
```html
<link rel="stylesheet" href="https://unpkg.com/terminal.css@0.7.1/dist/terminal.min.css" />
```
## Themes
To create your own theme just open the dev-tools and edit the CSS Variables. Copy and paste it to your website. Done!
## Development
- `npm install`
- `npm run start`
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -m 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request
## License
MIT © [Gioni06](https://github.com/Gioni06)