Skip to content

Commit

Permalink
Merge pull request #73 from schalkneethling/minor-fixes-docs
Browse files Browse the repository at this point in the history
minor: docs update
  • Loading branch information
schalkneethling authored Dec 19, 2024
2 parents a444f5b + 8571366 commit db1c8a1
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 2 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# minimalist

A minimal pure CSS starter library for most web projects.

## Getting minimalist

You can easily add minimalist to your existing or new project using the CLI.

```bash
npm create minimalist@latest
```

You will be prompted to enter the desctination directory into which the files will be copied.
Please ensure that this is relative to your project's root folder.

All that is left is to link the CSS in your project. The `main` file you must add is `minimalist.css`.
You will fnd this in `your-target-dir/minimalist/minimalist.css`.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "create-minimalist",
"version": "0.0.5",
"version": "0.0.6",
"description": "A minimal pure CSS starter library for most web projects.",
"type": "module",
"exports": "./src/index.js",
Expand Down
2 changes: 1 addition & 1 deletion src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { logger } from "./utils/logger.js";
const main = async () => {
console.clear();

intro("Thank you for choosing minimalist! 🧑🏿‍🎤");
intro("Thank you for choosing minimalist! 🐳");

const targetDir = await text({
message: "Enter the target directory relative to the project root.",
Expand Down

0 comments on commit db1c8a1

Please sign in to comment.