Skip to content

Commit 4415120

Browse files
committed
Ready to publish
1 parent 38bef47 commit 4415120

File tree

4 files changed

+82
-7
lines changed

4 files changed

+82
-7
lines changed

CHANGELOG

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Changelog
2+
3+
All notable changes to the "Bloom" project will be documented in this file.
4+
5+
### [0.1.0] - 2024-05-28
6+
7+
#### Added
8+
9+
- Initial release of the Bloom extension for Phoenix.
10+
- Components added:
11+
- Glow Button component with customisable colors and effects.
12+
- Mix tasks for installing components (`mix bloom.install`).
13+
14+
#### Changed
15+
16+
- N/A
17+
18+
#### Fixed
19+
20+
- N/A
21+
22+
#### Removed
23+
24+
- N/A
25+
26+
### [Unreleased]
27+
28+
- Planning to add more interactive components and enhance existing features based on user feedback.

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Christopher Gregori
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+20-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Bloom
22

3-
**TODO: Add description**
3+
The opinionated extention to Phoenix core_components.
4+
Inspired by shad-cn.
45

56
## Installation
67

7-
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
8-
by adding `bloom` to your list of dependencies in `mix.exs`:
8+
Can be installed by adding `bloom` to your list of dependencies in `mix.exs`:
99

1010
```elixir
1111
def deps do
@@ -15,7 +15,21 @@ def deps do
1515
end
1616
```
1717

18-
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
19-
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
20-
be found at <https://hexdocs.pm/bloom>.
18+
## Installing components
2119

20+
#### All components can be installed by running the following mix command in your project root
21+
22+
```
23+
mix bloom.install <component_name>
24+
```
25+
26+
#### View all components by running:
27+
28+
```
29+
mix bloom.install help
30+
```
31+
32+
## Components to add
33+
34+
- [x] Glow Button
35+
- [] Gradient Text

mix.exs

+13-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,19 @@ defmodule Bloom.MixProject do
77
version: "0.1.0",
88
elixir: "~> 1.16",
99
start_permanent: Mix.env() == :prod,
10-
deps: deps()
10+
deps: deps(),
11+
package: package(),
12+
description: "An Opinionated extention to Phoenix core_components."
13+
]
14+
end
15+
16+
defp package() do
17+
[
18+
name: "bloom",
19+
files: ~w(lib priv .formatter.exs mix.exs README* readme* LICENSE*
20+
license* CHANGELOG* changelog* src),
21+
licenses: ["MIT"],
22+
links: %{"GitHub" => "https://github.com/chrisgreg/bloom"}
1123
]
1224
end
1325

0 commit comments

Comments
 (0)