phreakx-social/README.md

Bootstrap & Font Awesome Social Media Buttons

# Phreakx Social Media Buttons

This small light weight package is an extension of Bootstrap's button component. It adds various brand colors for most social media platforms.

## Installation

`$ npm install phreakx-social --save`

Compile the SCSS yourself in your own preferred methodology.

Import into your main SASS or SCSS file

`@import '~phreakx-social/core';`

## Usage

Read Bootstraps Documentation on the Button component here: https://getbootstrap.com/docs/4.5/components/buttons/#examples

We have added some extension classes to define colors. All buttons must have the `btn-social` class added in order for this package to work properly.

## Examples

An example of all the buttons that are available as well as their classes can be found in the examples folder!

`/examples/images`

This app was originally designed in the Laravel Framework. I have added a Laravel Component in the examples folder that will help you create a page with all the buttons displayed so you can see what they look like/function.

The folder structure in the `/examples/LaravelApp` folder is exactly where you need to place the folders in your own laravel project.

*Note:* If you want to display the Brand's Logo, include your Font-Awesome script tag in the `/resources/views/layouts/app.blade.php` file.

## Changelog

-- Added Example Laravel Framework Component/Views
-- Added Example Images for Each Brand in /examples
-- Updated README.md Files
-- Initial Commit