Skip to content

Commit f6a470a

Browse files
authored
Update README.md
1 parent e5b67dc commit f6a470a

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.md

+50
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,56 @@
22
<img src="https://i.imgur.com/ihzCgEr.png">
33
</p>
44

5+
## Installing the CLI Locally
6+
7+
To install the Concise CLI in a project just run the following command:
8+
9+
```
10+
npm install -D ConciseCSS/concise.css#dev
11+
```
12+
13+
## Using Packages and Writing Styles
14+
15+
The Concise CLI can be used independently of any styles. In principle, it would will with any other CSS library, framework or any existing project so long as the code is plain CSS or contains only the features that can be compiled with PostCSS. Of course, one can start writing everything from scratch using Concise as well.
16+
17+
The core library contains the very basic styles that one might use, and contains most of the code that was available on Concise v4. This can be installed by running:
18+
19+
```
20+
npm install -D ConciseCSS/core#master
21+
```
22+
23+
You can then include Concise in your project by importing it into your stylesheet:
24+
25+
```
26+
@import '@concisecss/core';
27+
```
28+
29+
The previous line will include all the styles that Concise provides. However, it is also possible to include only the specific files that you would like:
30+
31+
```
32+
@import '@concisecss/core/settings.pcss';
33+
@import '@concisecss/core/base.pcss';
34+
```
35+
36+
Concise will automatically import the files from your `/node_modules` directory.
37+
38+
Once the packages are released and published on NPM they will be able to be installed by their name too: `concise.css` for the CLI and `@concisecss/<package>` for the other packages, including `core`.
39+
40+
## Compiling
41+
42+
Run the Concise CLI on the main file from the `package.json` scripts:
43+
44+
```
45+
concise compile main.pcss main.css
46+
```
47+
48+
To execute the CLI manually after installing locally (without the `package.json` scripts):
49+
50+
```
51+
npx concise compile main.pcss main.css
52+
```
53+
54+
The equivalent `concise watch` command will also watch the files for changes.
555

656
## Changelog
757

0 commit comments

Comments
 (0)