mirror of
https://github.com/Gioni06/terminal.css
synced 2025-03-09 09:09:04 -04:00
Add readme.md
This commit is contained in:
parent
0150a87a22
commit
766bcac491
36
README.md
Normal file
36
README.md
Normal file
@ -0,0 +1,36 @@
|
||||
# Terminal CSS
|
||||
|
||||
Modern and minimalistic CSS framework for *terminal* lovers ❤️
|
||||
|
||||
## Goal
|
||||
|
||||
There are so many CSS frameworks out there with great features but most of them come at the cost of *bloated* html code. **Terminal CSS** is here for purists who want minimal overhead and maximal control.
|
||||
|
||||
## Credits
|
||||
|
||||
This project is heavily inspired by [@egoist's](https://egoist.sh/) work - [hack.css](https://hackcss.egoist.moe/)
|
||||
|
||||
## Usage
|
||||
|
||||
#### NPM
|
||||
|
||||
Install with `npm i terminal.css`.
|
||||
|
||||
```js
|
||||
import 'terminal.css'
|
||||
```
|
||||
|
||||
#### UNPKG CDN
|
||||
|
||||
The css is available via [CDN](https://unpkg.com/terminal.css@0.1.0/dist/terminal.min.css)
|
||||
```html
|
||||
<link rel="stylesheet" href="https://unpkg.com/terminal.css@0.1.0/dist/terminal.min.css" />
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
- `npm install`
|
||||
- `npm run start`
|
||||
|
||||
## License
|
||||
MIT © [Gioni06](https://github.com/Gioni06)
|
@ -4,13 +4,14 @@
|
||||
"description": "Modern and minimalistic CSS framework for terminal enthusiasts",
|
||||
"main": "dist/terminal.min.css",
|
||||
"directories": {
|
||||
"doc": "docs",
|
||||
"docs": "docs",
|
||||
"dist": "dist"
|
||||
},
|
||||
"scripts": {
|
||||
"start": "node ./scripts/start.js",
|
||||
"build": "node ./scripts/build.js",
|
||||
"test": "echo \"Error: no test specified\" && exit 1"
|
||||
"test": "echo \"Error: no test specified\" && exit 1",
|
||||
"publish": "npm run build && npm publish"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
|
Loading…
x
Reference in New Issue
Block a user