Skip to content

Commit

Permalink
doc: add badges
Browse files Browse the repository at this point in the history
  • Loading branch information
bryanmylee committed May 10, 2022
1 parent 0f07797 commit c154412
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 4 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Svelte Headless Table

[![npm version](http://img.shields.io/npm/v/svelte-headless-table.svg)](https://www.npmjs.com/package/svelte-headless-table)
[![npm downloads](https://img.shields.io/npm/dm/svelte-headless-table.svg)](https://www.npmjs.com/package/svelte-headless-table)
![license](https://img.shields.io/npm/l/svelte-headless-table)
![build](https://img.shields.io/github/workflow/status/bryanmylee/svelte-headless-table/publish)
[![coverage](https://coveralls.io/repos/github/bryanmylee/svelte-headless-table/badge.svg?branch=main)](https://coveralls.io/github/bryanmylee/svelte-headless-table?branch=main)
[![size](https://img.shields.io/bundlephobia/min/svelte-headless-table)](https://bundlephobia.com/result?p=svelte-headless-table)

**Unopinionated and extensible data tables for Svelte**

> Build and design powerful datagrid experiences while retaining 100% control over styles and markup.
Expand All @@ -11,9 +18,11 @@ Get started with the [quick start guide](https://svelte-headless-table.bryanmyle
Beauty is subjective – everybody wants components to match their own theme! That's why Svelte Headless Table is **headless** by design. You are in full control of how your table looks, down to the very last component, class, and style.

### Declarative

Just describe how you want your tables to behave and let Svelte Headless Table handle the rest! It is designed with full TypeScript support and an intuitive API that lets you get started immediately.

### Extensible

Svelte Headless Table comes with a stable plugin system that allows you to transform and modify every step under the hood. If you want extra functionality, you can build it!

## The Plugin System
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "svelte-headless-table",
"version": "0.0.2-alpha.9",
"version": "0.1.0",
"scripts": {
"dev": "svelte-kit dev",
"build": "svelte-kit build",
Expand All @@ -27,7 +27,8 @@
"plugin",
"sort",
"filter",
"order"
"order",
"hidden"
],
"author": "Bryan Lee",
"license": "MIT",
Expand Down

0 comments on commit c154412

Please sign in to comment.