Skip to content

Commit

Permalink
Merge pull request #10 from ReeceM/initial-version-2
Browse files Browse the repository at this point in the history
Initial things for version 2
  • Loading branch information
ReeceM authored Jun 7, 2020
2 parents b63fdf4 + 78dcc7e commit bdacefc
Show file tree
Hide file tree
Showing 20 changed files with 2,303 additions and 930 deletions.
6 changes: 6 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
src
docs
postcss.config.js
tailwind.config.js
.editorconfig
.github
18 changes: 18 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,24 @@

All notable changes to `h-bar` will be documented in this file.

# 1.1.0 - 2020-05-15

***Changes***

- Only headers can be passed to the fetch function configs.
- only doing get requests basically.
- changed the names of the options values to not be so odd

__FIX__

- the fetch options config cleared all defaults

# 1.0.1 - 2020-04-09

__FIX__

The styling broke in firefox as sizing was missing the prefix.

# 1.0.0 - 2020-03-13

First initial major version of h-bar :)
Expand Down
30 changes: 10 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ The initialization object currently has this structure and defaults:
{
url: "https://your.blog/api/....",
onCompleted: "callback function",
postLink: "The link url, can be force and no need to fetch from API",
postTitle: "The link url, can be force and no need to fetch from API",
link: "The link url, can be force and no need to fetch from API",
title: "The link url, can be force and no need to fetch from API",
secondaryLinks: [
{
title: "Docs",
Expand All @@ -99,20 +99,10 @@ The initialization object currently has this structure and defaults:
],
parser: (data) => {/** Parser function */}
dismissible: false, // dismissible banner flag
dismissFor: new Date('2020-03-30'), // would dismiss it till end of march 30th
options: {
theme: "gray",
secondaryLinks: [],
onCompleted: null,
fetchOptions: {
"method": "GET",
"mode": "cors",
"cache": "no-cache",
"headers": {
"Accept": "application/json"
},
"redirect": "follow"
}
dismissFor: new Date('2020-03-30'), // would dismiss it till end of March 30th 2020
theme: "gray",
headers: {
"Authorization": "Bearer {TOKEN}"
},
customStyles: {
wrapper: "hb-flex hb-w-full hd-flex-col md:hb-flex-row sm:hb-flex-row hb-text-sm hb-py-2 md:hb-px-20 hb-px-1 hb-items-center hb-justify-between",
Expand Down Expand Up @@ -200,21 +190,21 @@ When you set this and the banner is dismissed, the UTC milliseconds are stored i
If you fail to set the value properly, it won't dismiss and the banner will show by default.


### Testing
## Testing

_to come_ please make a PR if you know how to do it on JS.

### Changelog
## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

### Security
## Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.
If you discover any security related issues, please email [email protected] instead of using the issue tracker. You can also use the [SECURITY](SECURITY.md) doc.

## Credits

Expand Down
115 changes: 115 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
# Security Policy

**PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY, [SEE BELOW](#reporting-a-vulnerability).**

## Supported Versions

Use this section to tell people about which versions of your project are
currently being supported with security updates.

| Version | Supported |
| ------- | ------------------ |
| 1.0.x | :white_check_mark: |
| < 0.3 | :x: |

## Reporting a Vulnerability

If you discover a security vulnerability, please send an email to Reece at [email protected].
All security vulnerabilities will be promptly addressed.

As the vulnerability is addressed and checked out I will attempt to keep you updated as things are sorted.

Please provide a proof of concept for what you did to find the vulnerability as well as any possible real world exploits that could lead to actual leakage of data or exploit

## Communication

Once you have made initial contact via email, now public issues, if they are opened it will be if it is deemed alright.

Please allow upto 24 Hours for a response.

## Credits

If you have found a vulnerability and it is found to be valid and is fixed, you will be credited with the discovery of the issue.

Obviously, this being open-source, there wouldn't be any payment for discovering vulnerabilities.

### Public PGP Key

```
-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: OpenPGP v2.0.8
Comment: https://sela.io/pgp/
xsFNBF5sBTMBEACf9OoEsOBGVGJ1q3wKnJXYfsLZMyYzDXkrWZ70Jvxfvls1sbu5
BJ7efrBzekgZ1aIoOjjZ2qXMaGHv0FCJLRqL3Wiv7kiMlc59q0Zr7ZMMU5FGASNl
f8iw1craew5bRfEqD6zcXR0MQbjoCLfpIVa8YJhe5k/NZhexybPNlevkYD0CTRqv
5alnFu2gEkx+sOlWUvCOfMbqo+UvMIS6yBWmlhbi/gYiFwzrm2CZrgTSotPBjNyX
QU8gzP2PCW1eFWOoj/hNLPzfglK5ZCfLX6Q6keALrJzlHOLsb/wXdWg/A16Nfktz
NN3nu3JRJIZYLSUfzjNFAZmS4RY0mswufTzQ8K10da7xRIfECzGVNABv0UslVdaJ
HufZ6cbuiVOUGpRWzFt0/CJqaR3Ok4SBOxLUy/xsKerfZpNmFvxiTXvpEt0NOWRO
M3YpA2H8jfcnhSfychCvGCA11cCnyqxL4SXrqe7OLGBQgTZg4EvSM52VNwANPbNB
qNNBcC2VRw1580730mOPK3Mev7ojfEJvB6NjsHQhJu8AGrOlG+XZzfKtb/nGP9XJ
WhIoNPrJHqqgd/sjwPAvE7sooo7pubjgxn7RQVV87/jG44e50D0gpn9z6Hm0q5vG
X0jJ0VrC0obwE7BbY4o6PDTo9l2evO0BQWxLREgCa7SDwxYn5qU0plbIVwARAQAB
zRF6c2gucmNlQGdtYWlsLmNvbcLBcAQTAQoAGgUCXmwFMwIbLwMLCQcDFQoIAh4B
AheAAhkBAAoJEFiTJcq5H0SyH14P/AhjbDsG/nlfqlp4aFlHpbd7aRo1JDEYYaDe
EongUAkqRLafZRC2KCUDfbvdey8FqTKNPPiKI5ELQHnhxauBAtwmOBcN+N1LzMl4
T3F/mx4/r6kf98TeBcIjxZmL0Q/4H0T3eSeRspreVLeXyIp0WnZYxBzgMK5ZuXxJ
ovBqXlKrRjz3HZehO2KA7IjqdH9HAyWYtK0plJrptayJN82+iqn0U+ut2DKjYUU2
BHiDakb6zpf6S4tbjuEA7WG+vr/6JYn/fxYijfwCuoQBLt+Xk3y5LX1zAauNVRTE
i91PSDKEamYuF/P+JXQADrjk0kRZoSX6bdqd/FmxaQyIn/O53CMoqjnCzKtxncim
vZF2/A/KG5d6Fk1bwOA/652XwSvYIvO2GLISriclsnUnxGZILibJbwH4MqRFrgTq
2vKUxOHleogUj7gtRMYILRI2m+340xRdKt8DMkb31woK7WlQlGp13Ra/zla/1LpX
MIo28mv9DW1Jh9LNwWZALDlQQyX8zbrdc3jExK2dKwY0xonw1FWKi5xH+nx0+zPE
JOvYPlj+YKTPdA1oElY7CnV4qE4g4lRUkfU83z6HTVob4wEJ40VltK0YqNBHvL34
YYU2i3RNwCNEIzWWbvoNyPOSlpk0hpLqWjKs5uWke8ktIYFi5VuX6jinYi74alN0
FLgTwQmXzsBNBF5sBTMBCADK7/UTHgR61I47rz8YI4Ll3kXIzYc9YFPKOhUf7T0Y
j038tWsn6REcs60q/S9nbL89F5gOGDCcd2PykQXtpZCGenZ0TeFXzVSnJ0nQq9eU
6mMWUT5ODAFIgmRk/PMyJs5f08u7Yx35jNTMEeZ69X8ewDSW0/7yRH9RFwergAwP
MHmfjKcGYZew7n8dGJWvyu9vnHtZp9TbOxEZVKXJKjDJnzWSmuqVh1C+n6kYXIQX
MXFVZdfQEk6AiNTAwnzV2bKahyxq6Alw87ZVPNGnycENP+RuNWrFrAfu5UQSgnOG
st7mqqESZOnqkbv3BQbmaK6Tt1A5QcbA/Cp1G3vrxGVzABEBAAHCwoMEGAEKAA8F
Al5sBTMFCQ8JnAACGy4BKQkQWJMlyrkfRLLAXSAEGQEKAAYFAl5sBTMACgkQPMpW
wQb/Lo9XWggApEvGHt7OXN6kpQyOdUTRqsz6TibpTsQsweQW2IBnv4gjTDGTpQUU
G/oYhfcolT5h0TDTe+/AxGPGdJa1S0Yu6xUESiMmE2y24bFOzxOKdISdW89hj/6y
U+hsfv2yce6RY/UgX8GIQyXlhN0rZhL6kwCZ7uKCTqeOxEblYm2CulL3WYUjFOWG
YHDQMjp3GzspUDeYDMQ2agihbP2FD4PL+zNe989NytyxrwxVGlUSUcPyj2Jp/2+E
GVQPQv8jxcZBXRvz2irJM/eS/ckOXNfxbYg/scqocpe1Nr7F2U8dQafL8t34XKVm
g4CwLSytKtjE7TMqxVg1WgocqfjnhSAhPmIDD/jEhVGDvr4+YkoCjGWOxBP7dWw5
xBKclMsnguG7E4cUeZ+vt8s61iikDYl/upJnT9s88w2bp8DN8yHjwCsFws5STv0G
b6wi+3IFu0Z9IL3692C2aARD44+LK9bttGhxn9eOeZk7kOni9njGSmFpJp2HHcMT
cRvj09UL0wkeenCKJTwUGbilVO+ZjldvktGSnF0UPJs7BEag587RSQT5DBfJnRqt
/ma1vJYieNWSVP3c33whKykxUnRLpn+GnUbhti7iOgCNy6xnTGTe3A9uSDi+7UHl
SqpE1GgxcY/QxrajP+eEHhARkWHR5zkjQ/MkuFr2L8MXiBP8rnlW1buCMK480/JC
igr61UJ8xB5aEXak00yBErP+3rSaI9jZp76ylo9lcf72O+KG1h0BvlAf0SNjElpx
GP3m+DpWFQ8YlpGo+QEfRdTuFbG2R3jaCXBU2DECqPTxyOWH5dzXUaUtgT9L4N5f
tCHmHugPXra7bcYf8xHMx2Vx4nMCsVisWMILv8aD4seTytGf3xX7/6UYKBsRrm6R
94HNBVAjmbeC/5Qr3OorNhtGtYu5kc2bO4S730TtuNch/kErP7aYFMtYAokOA0WU
RUK98fVV8yxq655ISxW01B3kRWYcSNmHMvbC3Yccn5OQKfB1qLHMt5/1Z0qw560L
bgfWrGES7k3bzk9/zsBNBF5sBTMBCADCzyInJ1a9wV3NAcoVGz1SkjyZ/TJnKeKN
BWHxjVrWMHuZtOHHP6bWnA7eew+Oso//hGmQ3YxMLojtwFLuyDzXeblhYmjtHaYR
93mpkoeCMaZ5+HJcUFuhWtqk2fzJ7lu0tsywzSC75dR7/bUdNlur3s2trGHJtHTU
qhFUOI8BJQ8yW4KWZm1XQejzMcKT2KHHVSOCjMDWVzmdFJtisP7V+yMrSsNxasL5
cWHe1nmXsowsPveTqq9AsF/nLqkrwTfHSgpp3+XDTWNzxIn65Ll72yPXFdOLrlIR
RGd/d+26QkAPybWmSvAAY6JWc2+SurJ8BeYCk+c61V0SbtIWMoMhABEBAAHCwoQE
GAEKAA8FAl5sBTMFCQ8JnAACGy4BKQkQWJMlyrkfRLLAXSAEGQEKAAYFAl5sBTMA
CgkQ/IEj9o9lX167jgf/XXhL7RuYavF9ZfONIdO+Mn0Zx3WEw0WmWNZCSLA8CbHa
Vpojb7CP79p9bdE/4qlSKmLx5MpziCZuVvG1X25N1VgWden3ZDK8tWRjeh2VzAOh
Q/ioFrwiEIwhZSfqFFs8H6Pz1lDL777QOX9UrOgWmtk+/ciwXa7VVV5Fs+wdGEg5
8fwBymY+F/TCTK/k6bMJYBOIE8iYhhSAc1daYMQ5qv5MOTCwZvCt4iqwtc/oOhvW
K7D+lgg3UrgfA2xeMgz1322k2CRNfaeHujMmXOpVNmPspARd6pI5q83aVzLqrVQX
Mo6WUj1FssHtJ4+HjOP3NNWGg9gh7cIzo22kpi5JeyCSD/9H1ozJ2INiXqpF3ydC
GdCtkQL+K3UdP0er53/kqanpfAjKlS2JDoaBesp79y9+jWpoeQx2dn0VT1eJwhdh
/eSNCOq4JeT8bIqHWX+YtmItSQ+ZQloCqSQB+9uNvGuYTzcYgEif4r6GG5TrY1nT
ksROTPa/lbWPVuatJcwHAdyb96zPNTYMYNroIbmWFmNXOpnnrjyNWnHEpVD4npZz
ULuZ6r9rGM0rjTCO2vnMgOOE7dfvWlnXMjIU8uQ8DSL7w1DgsQuB3xhSV6V55j7+
8EElgQ7bMcI1MXOgYiVRjoon2b1Xf4hre5U49aNLkWC9sDQSBPp3jLhjKWDry2BZ
M4O1rXC9FJil/9vENOhpAelvkPduW8PjsIhkouxconQw59oYGMvgIsL/8yl06uDY
Q0DbTp4TRXkIc69Rj/nQH8M/uqOHl/2hmYinC5s548Lza11hAarSa5uYqNZoOs/e
xzSi2OCAFlsWrPIGOJVlBtGtLsDmt2PPVSsU+8PVqSndi8pERn9eTuykHkK30aHr
sBJkv5/6RbNqvbTFnMDEct95FiqE2kWAZrHHP8ueN9Io3IzyUbkpWlJE/h9Mzq7T
5kLyqq2eqoNIIXccgL1tRTCl30i8hQDc9tarJ52f/6eV2EIZr1DH/u7CZd2YcH/I
WSP9/fPhYMd+HwxBDDUCc+taPQ==
=dwpr
-----END PGP PUBLIC KEY BLOCK-----
```
Loading

0 comments on commit bdacefc

Please sign in to comment.