-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor README.md for clarity and consistency
- Loading branch information
Showing
1 changed file
with
7 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/) |