Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Architrixs committed Jan 7, 2023
1 parent 4b79471 commit 8b2518d
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 15 deletions.
19 changes: 5 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# <date-time> element

A custom element that displays date and time.
A custom element that displays a date and time.

## Installation
Available on [npm](https://www.npmjs.com/) as [**@github/custom-element-element**](https://www.npmjs.com/package/@github/custom-element-element).
Available on [npm](https://www.npmjs.com/) as [**@architrixs/date-time-element**](https://www.npmjs.com/package/@architrixs/date-time-element).
```
$ npm install --save @github/custom-element-element
$ npm install --save @architrixs/date-time-element
```

## Usage
Expand All @@ -15,22 +15,13 @@ $ npm install --save @github/custom-element-element
Import as ES modules:

```js
import '@github/custom-element-element'
import '@architrixs/date-time-element'
```

Include with a script tag:

```html
<script type="module" src="./node_modules/@github/custom-element-element/dist/index.js">
```
An example Custom Element. This documentation ends up in the
README so describe how this elements works here.
You can event add examples on the element is used with Markdown.
```
<custom-element></custom-element>
<script type="module" src="./node_modules/@architrixs/date-time-element/dist/date-time.js">
```
## Browser support
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@architrixs/date-time-element",
"version": "0.0.1",
"version": "0.0.2",
"description": "A custom element that displays a date and time.",
"main": "dist/src/date-time.js",
"module": "dist/src/date-time.js",
Expand Down
5 changes: 5 additions & 0 deletions vscode.css-custom-data.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"version": 1.1,
"properties": [],
"pseudoElements": []
}

0 comments on commit 8b2518d

Please sign in to comment.