Skip to content

Commit

Permalink
docs: Fix 'usage' section
Browse files Browse the repository at this point in the history
- [Solved]<head> and <body> tags string weren't visible.
- [Added] Highlight the <script> as a code block
  • Loading branch information
elharony authored Oct 31, 2023
1 parent 1c335e1 commit ccbae13
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
The "Stand with Palestine" library/widget is a sticky bottom banner that you can easily integrate into your website to show your support for Palestine. It features the Palestine flag, a statement, "WE STAND WITH PALESTINE," and dynamic statistics, which include information on martyrs, hospital attacks, destroyed homes, and more, sourced from the Palestinian Ministry of Health.

## Usage
To add the "Stand with Palestine" banner to your website, all you have to do is adding the following script tag to the <head> tag or before the end of the </body> tag on your website:
`<script src="https://webkeyz.github.io/stand-with-palestine/dist/stand-with-palestine-widget.js"></script>`
To add the "Stand with Palestine" banner to your website, all you have to do is adding the following script tag to the `<head>` tag or before the end of the `</body>` tag on your website:
```html
<script src="https://webkeyz.github.io/stand-with-palestine/dist/stand-with-palestine-widget.js"></script>
```

## How it works?
The "Stand with Palestine" banner is created using SCSS and JavaScript. All styles are converted to CSS, and HTML elements are dynamically created using JavaScript, allowing for seamless integration without the need to modify your website's HTML structure. The library is bundled using `Webpack`, resulting in a single JavaScript file, which is available at `/dist/stand-with-palestine-widget.js`
Expand All @@ -19,4 +21,4 @@ We welcome contributions to enhance and improve the "Stand with Palestine" libra
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and ensure that the code is well-documented and tested.
4. Submit a pull request.
4. Submit a pull request.

0 comments on commit ccbae13

Please sign in to comment.