diff --git a/README.md b/README.md index 9666bd1..d597f17 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,91 @@ # Toast A jQuery plugin to make the usage of Bootstrap 4 toasts easy. + +* [About](#about) +* [Usage](#usage) +* [Caveats](#caveats) +* [Roadmap](#roadmap) + + +### About + +As of Bootstrap 4.2, [toasts](https://getbootstrap.com/docs/4.2/components/toasts/) have been inroduced and the aim of this plugin was to make it easier to use them. + +### Usage + +You can pass to `$.toast` an object with the settings for your toast and the settings are as follows: + +| Parameter |Description| Default | Values | +| ------------- |-----------| ------- |--------- +| title | Shows in the top left corner of the toast | 'Notice!'| | +| subtitle | Shows in the top right corner of the toast| N/A | | +| content | Show in the toast body | N/A | +| type | Determines the style of the toast based on Bootstrap styles | 'info' | 'info', 'success', 'warning', 'error' +| delay | Determines how the toast will show for | 3000 + +**Note:** If content is omitted, the toast will not have a `.toast-body` and can be used as a small toast which will be shown below in the examples. + +```javascript +$.toast({ + title: 'Toast', + subtitle: '11 mins ago', + content: 'Hello, world! This is a toast message.', + type: 'info', + delay: 5000 +}); +``` + +![Example #1](https://i.gyazo.com/20fbdf05b57af4a76e28f66047fe6591.png) + +The respective markdown for the above would be: + +``` +