Skip to content

Commit 9bd8e87

Browse files
committed
README.md update
1 parent 461263b commit 9bd8e87

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,27 @@
11
# Seed Styles and Hooks
22

3+
- This repo has been created from these ones:
4+
- https://github.com/rebo/atomic_hooks
5+
- https://github.com/rebo/seed_style_preview
6+
- https://github.com/rebo/seed_hooks
7+
8+
- The main purpose of the repo is to group libraries `atomic_hooks`, `seed_hooks` and `seed_styles` to make development faster and easier.
9+
10+
- _Note:_ There are still active issues in the repos above and all corresponding crates currently deployed on [crates.io](https://crates.io/) are based on them.
11+
12+
- You can find tutorials and documentation on [seed-style-hooks.netlify.app](https://seed-style-hooks.netlify.app/), however it's possible that some information will become obsolete.
13+
14+
- Include chosen libraries in your Seed project this way:
15+
```rust
16+
[dependencies]
17+
seed_styles = { git = "https://github.com/seed-rs/styles_hooks", package = "seed_styles", branch = "main" }
18+
seed_hooks = { git = "https://github.com/seed-rs/styles_hooks", package = "seed_hooks", branch = "main" }
19+
atomic_hooks = { git = "https://github.com/seed-rs/styles_hooks", package = "atomic_hooks", branch = "main" }
20+
```
21+
22+
- All libraries use Seed's `master` branch.
23+
24+
- _Development:_
25+
- Please run at least `cargo build` from the root before `push` to make sure all libraries are still compatible. We'll setup CI with tests and linters later.
26+
- Use `stable` and the latest Rust version (`$ rustup update`).
27+
- Squash commits and try to respect [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).

0 commit comments

Comments
 (0)