Skip to content

Commit

Permalink
Update README, and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cipherlogs committed Feb 1, 2024
1 parent 2650006 commit 6f22e17
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 22 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Klassco
Just as components helps developpers abstract and avoid repetition,
**Klassco** does the same to your css classnames inside your components.
**Klassco** helps you do the same to your css classnames inside your
components.


<br />
Expand Down
32 changes: 32 additions & 0 deletions docs/pages/basic-usage/installation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
import {Tabs} from "nextra/components"

# Getting Started

The simplest and fastest way to install Klassco is by using a JavaScript
package manager.

<Tabs items={["pnpm", "bun", "npm", "yarn"]}>
<Tabs.Tab>
```bash
pnpm i klassco
```
</Tabs.Tab>
<Tabs.Tab>
```bash
bun add klassco
```
</Tabs.Tab>
<Tabs.Tab>
```bash
npm i klassco
```
</Tabs.Tab>
<Tabs.Tab>
```bash
yarn add klassco
```
</Tabs.Tab>
</Tabs>

If you want to build from source, see the
[repo](https://github.com/cipherlogs/klassco) for guidance.
5 changes: 0 additions & 5 deletions docs/pages/basic-usage/usage.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion docs/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ all the conventions that have emerged, such as CSS in Javascript, SMACSS,
OOCSS, BEM, and atomic approaches like Tailwind.


## 3. Should I be worried?
## 3. Should I be worried? [#big-goal]
One might assume that the deliberate repetition of classes in Tailwind is
without consequences, and that employing front-end components is the optimal
strategy to address this issue. This assumption is not accurate, and we will
Expand Down
6 changes: 5 additions & 1 deletion docs/pages/quick-start.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Quick Start
Still under development...
In this series, we'll explore a set of features and core concepts to
understand the utility of the tool. By the end of the series, you should be
able to make an informed decision about its usefulness.

<ins>Still under development...</ins>

To get notified as soon as the documentation is fully done, use this
[link](https://cipherlogs.com/newsletter).
Expand Down
17 changes: 3 additions & 14 deletions docs/pages/quick-start/phase1.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
import {Steps, Callout} from "nextra/components"

# Quick Start: Phase 1
In this phase of the [`Quick Start`](/quick-start) series, we'll explore a set
of features and core concepts to understand the utility of the tool. By the
end of the series, you should be able to make an informed decision about its
usefulness.

Let's examine an example snippet:
Consider this snippet:

```js
className="ring-inset focus-within:ring-inset"
Expand All @@ -20,9 +15,8 @@ later when you perform a quick scan **on your project**, you will be surprised
to find numerous instances.

<Callout type="info">
It's important to note that tools like `eslint-plugin-tailwindcss`, the
`headwind` VS Code extension, or `tailwind-merge` are unable to remove these
specific types of duplicates.
Tools like `eslint-plugin-tailwindcss`, the `headwind` VS Code extension, or
`tailwind-merge` are unable to remove these specific types of duplicates.
</Callout>

## Analyzing Real-World Code
Expand Down Expand Up @@ -126,11 +120,6 @@ or remove duplicates, only the true duplicates will be removed.
learn how [**-m --min** [&#8599;]](/options/min) works.
</Callout>

<Callout type="info">If you have `tailwind-prettier`, all duplicates will be
grouped together. However, for compatibility with vanilla CSS or other CSS
libraries, Klassco assumes you don't have it.</Callout>



## Your turn
Try scanning the whole `src` directory of one of your projects with Klassco:
Expand Down

0 comments on commit 6f22e17

Please sign in to comment.