Skip to content

Commit

Permalink
Refactor README.md for clarity and consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
royalfig committed Sep 9, 2024
1 parent 0caf5f3 commit 1a67718
Showing 1 changed file with 7 additions and 14 deletions.
21 changes: 7 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,19 @@
# Sharing Is Caring Web Component
![Sharing symnbol](./docs/public/galaxy.avif)

# Sharing Button Web Component

Use this web component to add a button for sharing the current page to social media (Twitter/X, Facebook, LinkedIn) or copying the URL.

## Installation


There are two ways to add your share button to the page.

1. Use the CDN

Add the following script tag to your head.

```html
<script defer src="https://unpkg.com/@royalfig/share-button/dist/share-button.umd.js"></script>
```

2. Install with NPM
**Install with NPM**

```bash
npm install @royalfig/share-button
```

See the docs below for more installation options.

## Docs

For customization and advanced usage, see the [official docs](https://royalfig.github.io/share-button/)
For customization and advanced usage, see the [official docs](https://royalfig.github.io/share-button/)

0 comments on commit 1a67718

Please sign in to comment.