Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mskocik committed Dec 12, 2024
1 parent 60e050e commit 38818b6
Showing 1 changed file with 21 additions and 44 deletions.
65 changes: 21 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,35 @@
# create-svelte
# 📅 Svelty Picker [![NPM version](https://img.shields.io/npm/v/svelty-picker.svg?style=flat)](https://www.npmjs.org/package/svelty-picker)

Everything you need to build a Svelte library, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
Simple date & time picker implemented in svelte.

Read more about creating a library [in the docs](https://svelte.dev/docs/kit/packaging).
Features:
- date/time/datetime/range picker mode
- various formatting options
- keyboard navigation
- replacable slots
- themable
- customizable disabled dates

## Creating a project
## ⚙️ Install

If you're seeing this, you've probably already done this step. Congrats!

```bash
# create a new project in the current directory
npx sv create

# create a new project in my-app
npx sv create my-app
```js
npm install svelty-picker
```

## Developing

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:

```bash
npm run dev
If you need svelte 4 version:

# or start the server and open the app in a new browser tab
npm run dev -- --open
```js
npm install svelty-picker@5
```

Everything inside `src/lib` is part of your library, everything inside `src/routes` can be used as a showcase or preview app.
### Documentation

## Building
For more details check the [documentation](https://svelty-picker.vercel.app/)

To build your library:
## 🏆 Thanks to:

```bash
npm run package
```

To create a production version of your showcase app:
- [Bootstrap datepicker](https://github.com/smalot/bootstrap-datetimepicker/blob/master/js/bootstrap-datetimepicker.js) for some internal date and format handling

```bash
npm run build
```
## Licence

You can preview the production build with `npm run preview`.

> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
## Publishing

Go into the `package.json` and give your package the desired name through the `"name"` option. Also consider adding a `"license"` field and point it to a `LICENSE` file which you can create from a template (one popular option is the [MIT license](https://opensource.org/license/mit/)).

To publish your library to [npm](https://www.npmjs.com):

```bash
npm publish
```
MIT

0 comments on commit 38818b6

Please sign in to comment.