Skip to content

Commit

Permalink
Update docs and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fymmot committed Jan 11, 2023
1 parent 0c128df commit d1e5c72
Show file tree
Hide file tree
Showing 4 changed files with 216 additions and 11 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@

<div>
<img alt="Github test action status" src="/~https://github.com/fymmot/inclusive-dates/actions/workflows/test.yml/badge.svg" />
<!-- <img alt="Github publish action status" src="/~https://github.com/inclusive-dates-v2/actions/workflows/publish.yml/badge.svg" />
<img alt="Github docs action status" src="/~https://github.com/inclusive-dates-v2/actions/workflows/docs.yml/badge.svg" /> -->
<!-- <img alt="Github publish action status" src="/~https://github.com/inclusive-dates-v2/actions/workflows/publish.yml/badge.svg" /> -->
<img alt="Github docs action status" src="/~https://github.com/inclusive-dates/actions/workflows/docs.yml/badge.svg" />
</div>
</div>

## Features

- 🧏‍ **Smart date parsing**: Accepts natural language input using Chrono.js. Try typing "yesterday", "May tenth" or "in one year"!.
- 🧏‍ **Natural language input**: Text field accepts natural language input using Chrono.js. Try typing "yesterday", "May tenth" or "in one year"!.
- 🧏‍ **Accessibility first**: Built to support users of assistive technology. Follows the WAI-ARIA APG Datepicker dialog pattern.
- 🦶 **Small footprint**: Base version is about 8 KB minified and gzipped. About 50kb with Chrono.js language parsing.
- 🪁 **Low dependency**: Few external dependencies.
- 🖼 **Framework-agnostic**: Standard Web Component that works with any framework.
- 🖼 **Framework-agnostic**: Standard Web Component that works with any framework – or no framework at all.
- 🦶 **Small footprint**: The component is ~45KB minified and gzipped with Chrono.js. If you do not need language parsing, the original sqrrl/wc-datepicker calendar is ~4KB
- 🪁 **Low dependency**: External dependencies limited to accessibility utils (@react-aria/live-announcer, @a11y/focus-trap and aria-hidden).
- 💪 **Strongly typed**: Written in TypeScript.
- 🇪🇺 **Localizable**: Customizable labels and date formats.
- 🌈 **Customizable**: Semantic markup with no built-in styles.
Expand Down
16 changes: 16 additions & 0 deletions docs/css/bamboo.css
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,22 @@ h2#features + ul > li {
margin-top: 1rem;
margin-bottom: 1rem;
}
.about-me {
display: flex;
gap: 2rem;
align-items: center;
}

.dark .useit-logo {
filter: invert(1);
}
footer {
margin-bottom: 2rem;
margin-top: 4rem;
}
.fistbump {
width: 100%;
}

li > ul,
li > ol {
Expand Down
Binary file added docs/images/fistbump.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

1 comment on commit d1e5c72

@vercel
Copy link

@vercel vercel bot commented on d1e5c72 Jan 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

inclusive-dates – ./

inclusive-dates-git-main-fymmot.vercel.app
inclusive-dates-fymmot.vercel.app
inclusive-dates.vercel.app

Please sign in to comment.