Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

Commit

Permalink
docs: update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
k11q committed Jan 13, 2023
1 parent 245cf00 commit d5b4ed7
Show file tree
Hide file tree
Showing 10 changed files with 3,434 additions and 816 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ node_modules
!.env.example
vite.config.js.timestamp-*
vite.config.ts.timestamp-*
.vercel
36 changes: 14 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,30 @@
# create-svelte
# Noir-UI

Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
Noir-UI is a low-level component library with built in accessibility, built for building high quality design systems.

## Creating a project
## Installation

If you're seeing this, you've probably already done this step. Congrats!
Noir-UI is currently in version 0.0.1 and not suitable for production. However to try it, run:

```bash
# create a new project in the current directory
npm create svelte@latest
npm install @noir-ui/svelte

# create a new project in my-app
npm create svelte@latest my-app
# or pnpm or yarn
```

## Developing
## Documentation

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
Visit the official [site](https://noir-ui-com.vercel.app).

```bash
npm run dev
## Author

# or start the server and open the app in a new browser tab
npm run dev -- --open
```
[Khairul Haaziq](https://github.com/khairulhaaziq)

## Building
## Contributing

To create a production version of your app:
Coming soon.

```bash
npm run build
```
## License

You can preview the production build with `npm run preview`.
MIT License. Copyright Khairul Haaziq 2023.

> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
23 changes: 5 additions & 18 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@noir-ui/svelte",
"version": "0.0.17",
"name": "souvre-ui",
"version": "0.0.1",
"scripts": {
"dev": "vite dev",
"build": "svelte-kit sync && svelte-package",
Expand All @@ -9,8 +9,7 @@
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
"lint": "prettier --plugin-search-dir . --check . && eslint .",
"format": "prettier --plugin-search-dir . --write .",
"test": "vitest",
"package": "svelte-kit package"
"test": "vitest"
},
"devDependencies": {
"@radix-ui/colors": "^0.1.8",
Expand Down Expand Up @@ -41,17 +40,5 @@
"dependencies": {
"install": "^0.13.0",
"lucide-svelte": "^0.104.0"
},
"description": "Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).",
"main": "svelte.config.js",
"repository": {
"type": "git",
"url": "git+https://github.com/khairulhaaziq/noir-ui.git"
},
"author": "",
"license": "MIT",
"bugs": {
"url": "https://github.com/khairulhaaziq/noir-ui/issues"
},
"homepage": "https://github.com/khairulhaaziq/noir-ui#readme"
}
}
}
Loading

0 comments on commit d5b4ed7

Please sign in to comment.