Skip to content

Commit

Permalink
chore: update readmes (#13)
Browse files Browse the repository at this point in the history
* chore: update every packages readme

* update publishing process docs
  • Loading branch information
golota60 authored Jan 14, 2024
1 parent 3f57832 commit b868b9c
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 1 deletion.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 Szymon Wiszczuk and other contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
2 changes: 1 addition & 1 deletion PUBLISHING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Currently, publishing is done manually. Simply,

1. Create a new branch
2. Bump the version and commit
2. Bump the version of each package and commit. We want to keep sync between each oxytail package version. Also update documentation and every mention of version to be installed(including each packages `Cargo.toml`!).
3. Run the following commands

```
Expand Down
6 changes: 6 additions & 0 deletions oxytail-base/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[![crates.io](https://img.shields.io/crates/v/oxytail-base.svg)](https://crates.io/crates/oxytail-base)
[![Released API docs](https://docs.rs/oxytail-base/badge.svg)](https://docs.rs/oxytail-base)

## Oxytail Base

This package contains the base widgets for [oxytail](https://github.com/golota60/oxytail) and the "core" of how themes work. Refer to that repos README for more info!
6 changes: 6 additions & 0 deletions oxytail-theme-dark/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[![crates.io](https://img.shields.io/crates/v/oxytail-dark-theme.svg)](https://crates.io/crates/oxytail-dark-theme)
[![Released API docs](https://docs.rs/oxytail-dark-theme/badge.svg)](https://docs.rs/oxytail-dark-theme)

## Oxytail dark theme

This package contains the implementation for a dark theme for [oxytail](https://github.com/golota60/oxytail). Refer to that repos README for more info!
6 changes: 6 additions & 0 deletions oxytail-theme-defaults/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[![crates.io](https://img.shields.io/crates/v/oxytail-theme-defaults.svg)](https://crates.io/crates/oxytail-theme-defaults)
[![Released API docs](https://docs.rs/oxytail-theme-defaults/badge.svg)](https://docs.rs/oxytail-theme-defaults)

## Oxytail theme defaults

This package contains a set of defaults for creating custom [oxytail](https://github.com/golota60/oxytail) themes. Refer to that repos README for more info!

0 comments on commit b868b9c

Please sign in to comment.