Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
driesvints committed Jun 17, 2020
1 parent d446e6b commit 68cea6d
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 19 deletions.
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Blade Icons

<a href="https://github.com/adamwathan/blade-svg/actions?query=workflow%3ATests">
<img src="https://github.com/adamwathan/blade-svg/workflows/Tests/badge.svg" alt="Tests">
<a href="https://github.com/blade-ui-kit/blade-icons/actions?query=workflow%3ATests">
<img src="https://github.com/blade-ui-kit/blade-icons/workflows/Tests/badge.svg" alt="Tests">
</a>
<a href="https://github.com/adamwathan/blade-svg/actions?query=workflow%3A%22Code+Style%22">
<img src="https://github.com/adamwathan/blade-svg/workflows/Code%20Style/badge.svg" alt="Code Style">
<a href="https://github.com/blade-ui-kit/blade-icons/actions?query=workflow%3A%22Code+Style%22">
<img src="https://github.com/blade-ui-kit/blade-icons/workflows/Code%20Style/badge.svg" alt="Code Style">
</a>
<a href="https://packagist.org/packages/nothingworks/blade-svg">
<img src="https://poser.pugx.org/nothingworks/blade-svg/v/stable.svg" alt="Latest Stable Version">
<a href="https://packagist.org/packages/blade-ui-kit/blade-icons">
<img src="https://poser.pugx.org/blade-ui-kit/blade-icons/v/stable.svg" alt="Latest Stable Version">
</a>
<a href="https://packagist.org/packages/nothingworks/blade-svg">
<img src="https://poser.pugx.org/nothingworks/blade-svg/d/total.svg" alt="Total Downloads">
<a href="https://packagist.org/packages/blade-ui-kit/blade-icons">
<img src="https://poser.pugx.org/blade-ui-kit/blade-icons/d/total.svg" alt="Total Downloads">
</a>

A package to easily make use of SVG icons in your Laravel Blade views.
A package to easily make use of SVG icons in your Laravel Blade views. Originally "Blade SVG" by [Adam Wathan](https://twitter.com/adamwathan).

- [Icon Packages](#icon-packages)
- [Requirements](#requirements)
Expand Down Expand Up @@ -50,7 +50,7 @@ We're not accepting requests to build new icon packages ourselves but you can [s
## Installation

```bash
composer require nothingworks/blade-svg
composer require blade-ui-kit/blade-icons
```

After installing the package, publish the configuration and **uncomment** the `default` icon set:
Expand Down Expand Up @@ -237,7 +237,7 @@ Now your icons can be referenced using a component, directive or helper:
{{ svg('heroicon-o-bell') }}
```

Don't forget to make `nothingworks/blade-svg` a requirement of your package's `composer.json`.
Don't forget to make `blade-ui-kit/blade-icons` a requirement of your package's `composer.json`.

## Changelog

Expand All @@ -247,8 +247,6 @@ Check out the [CHANGELOG](CHANGELOG.md) in this repository for all the recent ch

Blade Icons is developed and maintained by [Dries Vints](https://driesvints.com).

It draws inspiration from the original [Blade SVG](https://github.com/adamwathan/blade-svg) package by [Adam Wathan](https://twitter.com/adamwathan).

## License

Blade Icons is open-sourced software licensed under [the MIT license](LICENSE.md).
4 changes: 2 additions & 2 deletions UPGRADE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ General steps for every update:

## Upgrading from v0.3.4 to 0.4.0

0.4.0 is a complete rewrite. If you haven't yet, [read the announcement pr](https://github.com/adamwathan/blade-svg/pull/50). The package has been rewritten from the ground up and the public API has drastically changed. Most notable is the added support for Blade component syntax. While it'd be impossible to reference to every single breaking change, please refer below for the most notable ones:
0.4.0 is a complete rewrite. If you haven't yet, [read the announcement pr](https://github.com/blade-ui-kit/blade-icons/pull/50). The package has been rewritten from the ground up and the public API has drastically changed. Most notable is the added support for Blade component syntax. While it'd be impossible to reference to every single breaking change, please refer below for the most notable ones:

### Package Renaming

**The package has been renamed to Blade Icons.** For the beta period, it'll keep the `nothingworks/blade-svg` composer package name but it'll be renamed to a new name before we tag 0.4.0 and it'll be moved to a new organisation. More news on that as soon as the 0.4.0 beta period has ended.
**The package has been renamed to Blade Icons.** It's also been moved to the Blade UI Kit organisation. You should update your reference in your `composer.json` to `blade-ui-kit/blade-icons`.

### Minimum Requirements

Expand Down
8 changes: 4 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"name": "nothingworks/blade-svg",
"name": "blade-ui-kit/blade-icons",
"description": "A package to easily make use of icons in your Laravel Blade views.",
"keywords": ["Blade", "Icons", "Laravel", "SVG"],
"homepage": "https://github.com/nothingworks/blade-svg",
"homepage": "https://github.com/blade-ui-kit/blade-icons",
"license": "MIT",
"support": {
"issues": "https://github.com/nothingworks/blade-svg/issues",
"source": "https://github.com/nothingworks/blade-svg"
"issues": "https://github.com/blade-ui-kit/blade-icons/issues",
"source": "https://github.com/blade-ui-kit/blade-icons"
},
"authors": [
{
Expand Down

0 comments on commit 68cea6d

Please sign in to comment.