# Rosely

## A warm and serene colour palette based on millennial pink

<p align="center"><a href="https://rosely.hellotham.com" target="_blank"><img src="https://github.com/ChristineTham/rosely/raw/master/images/icon.svg" width="150" height="150"/></a></p>

<p align="center">
  A total of sixteen, carefully selected, low contrast pastel colours inspired by millennial pink for a eye-comfortable,
  but yet colourful ambiance.
</p>

<p align="center">
  It is a deliberately low contrast theme full of soothing contemporary colours designed to induce calmness and serenity and works well
  even on lower contrast displays. It is not eye fatiguing as it avoids high contrast colour changes and helps the eyes to focus on what
  is important.
</p>

<p align="center">Rosely is created for <strong>clear, uncluttered and elegant designs</strong> following a <strong>minimal and flat</strong> style pattern.
For syntax highlighting it aims to ensure an <strong>undisturbed focus on important parts of the code</strong>, a <strong>good readability</strong> and a <strong>quick visual distinction</strong> between the different syntax elements.</p>

<p align="center">Rosely consists of four named colour palettes providing different syntactic meanings and colour effects for dark & bright ambiance designs.</p>

[![Rosely Color Palette Overview](https://github.com/ChristineTham/rosely/raw/master/images/rosely.png)](https://rosely.hellotham.com/docs/colours-and-palettes)

Rosely is a simple and uncluttered design system based on the warm and embracing gentle colour of rose quartz crystals (popularly known
as *Millennial Pink*), together with
a fresh and positive colour palette that symbolises adventuresome exploration of newness and originality.

If ever there was a time when we needed to surround ourselves with colours that infuse feelings of calmness and positivity into our environment,
it is now. As we continue down this path of uncertainty, a time marked by a global pandemic and social distancing coupled with social unrest
demanding action on equality and sustainability, people seek mindfulness and well-being as an antidote to the stress of modern day lives.

Rosely has a base colour that psychologically fulfil a yearning for reassurance and security.
Additional colours symbolises the brighter future that lies ahead that expresses a sense of playful freshness and optimism that brings a
smile to our face as it takes us forward.

All colours are numbered from `rosely0` to `rosely15` where each palette contains a different amount of colours, with semantic meanings
similar to the [Nord](https://www.nordtheme.com) palette. The naming convention preserves the compatibility for terminal colour schemes
and allows an uncomplicated use as base for such.

Rosely can be used as a drop in replacement package for *Nord* in projects simply by replacing the `nord` npm package with `rosely`.

Rosely is also compatible with the [base16](http://chriskempson.com/projects/base16/) architecture by redefining `base00` to `base0F` with
Rosely equivalent colours. Light and dark base16 schemes are included in this package.

## Getting Started

Visit the [official website][home] to [learn all about Rosely's colours and palettes][home-docs-colours] and how to [install and integrate Rosely in your own projects][home-docs-usage] or use the [colour swatches for your favorite applications][home-docs-swatches].

### Quick Start

Install Rosely using [npm][] or [yarn][]:

```sh
# npm
npm install --save rosely

# yarn
yarn add rosely
```

Please see the complete [installation and usage guide][home-docs-usage] for more details.

## Themes for Applications

Unify the appearance and usage experience for your favorite applications — from code editors, shell terminals to modern UIs and libraries.

Rosely supports a broad and constantly growing spectrum that allows to [customise your daily tool stack][home-themes].

<p align="center"><a href="https://rosely.hellotham.com/themes"><img src="https://github.com/ChristineTham/rosely/raw/master/images/wireframe.svg?sanitize=true" alt="Rosely theme project illustration" /></a></p>

## Colour Swatches

Next to the many ways of [integrating Rosely into your project][home-docs-usage], all [colour palettes of Rosely][home-docs-colours] are also available in [various native colour swatch formats][home-docs-swatches].

Easily import Rosely into macOS, _Adobe_ products like _Photoshop_ & _Illustrator_, GIMP/Krita/Inkscape and many more.

<p align="center"><a href="https://rosely.hellotham.com/docs/palette"><img src="https://raw.githubusercontent.com/ChristineTham/rosely/master/images/palette.svg?sanitize=true" alt="Rosely palette swatches illustration" /></a></p>

## Contributing

Rosely is an open source project and we love to receive contributions!

There are many ways to contribute, from [writing- and improving documentation and tutorials][contrib-guide-docs], [reporting bugs][contrib-guide-bugs], [submitting enhancement suggestions][contrib-guide-enhance] that can be added to Rosely by [submitting pull requests][contrib-guide-pr].

Please take a moment to read the full [contributing guide][contrib-guide] to learn about the development process, the project's used [styleguides][contrib-guide-styles], [branch organization][contrib-guide-branching] and [versioning][contrib-guide-versioning] model.

The guide also includes information about [minimal, complete, and verifiable examples][contrib-guide-mcve] and other ways to contribute to the project like [improving existing issues][contrib-guide-impr-issues] and [giving feedback on issues and pull requests][contrib-guide-feedback].

<p align="center"><img src="https://raw.githubusercontent.com/ChristineTham/rosely/master/images/product-iteration.svg?sanitize=true" /></p>

<p align="center">Copyright &copy; 2020 <a href="https://www.hellotham.com" target="_blank">Hello Tham</a> and <a href="https://christham.net" target="_blank">Chris Tham</a></p>

<p align="center"><a href="https://github.com/hellotham/rosely/blob/master/LICENSE.md"><img src="https://img.shields.io/static/v1.svg?style=flat-square&label=License&message=MIT&logoColor=eceff4&logo=github&colorA=4c566a&colorB=88c0d0"/></a></p>

[contrib-guide-branching]: https://github.com/hellotham/rosely/blob/master/CONTRIBUTING.md#branch-organization
[contrib-guide-bugs]: https://github.com/hellotham/rosely/blob/master/CONTRIBUTING.md#bug-reports
[contrib-guide-docs]: https://github.com/hellotham/rosely/blob/master/CONTRIBUTING.md#documentations
[contrib-guide-enhance]: https://github.com/hellotham/rosely/blob/master/CONTRIBUTING.md#enhancement-suggestions
[contrib-guide-feedback]: https://github.com/hellotham/rosely/blob/master/CONTRIBUTING.md#give-feedback-on-issues-and-pull-requests
[contrib-guide-impr-issues]: https://github.com/hellotham/rosely/blob/master/CONTRIBUTING.md#improve-issues
[contrib-guide-mcve]: https://github.com/hellotham/rosely/blob/master/CONTRIBUTING.md#mcve
[contrib-guide-pr]: https://github.com/hellotham/rosely/blob/master/CONTRIBUTING.md#pull-requests
[contrib-guide-styles]: https://github.com/hellotham/rosely/blob/master/CONTRIBUTING.md#styleguides
[contrib-guide-versioning]: https://github.com/hellotham/rosely/blob/master/CONTRIBUTING.md#versioning
[contrib-guide]: https://github.com/hellotham/rosely/blob/master/CONTRIBUTING.md
[home-comm]: https://rosely.hellotham.com/
[home-docs-colours]: https://rosely.hellotham.com/docs/colours-and-palettes
[home-docs-swatches]: https://rosely.hellotham.com/docs/palette
[home-docs-usage]: https://rosely.hellotham.com/docs/projects
[home-themes]: https://rosely.hellotham.com/themes
[home]: https://rosely.hellotham.com
[npm]: https://www.npmjs.com
[yarn]: https://yarnpkg.com
