Skip to content

Commit f489a92

Browse files
authored
🔀 Merge pull request #305 from royshreyaaa/updated-readme
Updated README.md
2 parents 705bad5 + 8dfa598 commit f489a92

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
<h1 align="center">Dashy</h1>
33
<p align="center">
4-
<i>Dashy helps you organize your self-hosted services, by making them all accessible from a single place</i>
4+
<i>Dashy helps you organize your self-hosted services by making them accessible from a single place</i>
55
<br/>
66
<img width="120" src="https://i.ibb.co/yhbt6CY/dashy.png" />
77
<br/>
@@ -66,25 +66,25 @@
6666

6767
## Features 🌈
6868

69-
- 🔎 Instant search by name, domain and tags + customizable hotkeys & keyboard shortcuts
69+
- 🔎 Instant search by name, domain or tags + customizable hotkeys & keyboard shortcuts
7070
- 🎨 Multiple built-in color themes, with UI color editor and support for custom CSS
71-
- 🧸 Many icon options- Font-Awesome, homelab icons, auto-fetching favicon, images, emojis, etc
72-
- 🚦 Status monitoring for each of your apps / links, for basic availability and uptime checking
71+
- 🧸 Many icon options - Font-Awesome, homelab icons, auto-fetching favicon, images, emojis, etc.
72+
- 🚦 Status monitoring for each of your apps / links for basic availability and uptime checking
7373
- 💂 Optional authentication with multi-user access, configurable privileges and SSO support
7474
- 🌎 Multi-language support, with 10+ human-translated languages, and more on the way
7575
- ☁ Optional, encrypted, free off-site cloud backup and restore feature available
7676
- 💼 A workspace view, for easily switching between multiple apps at simultaneously
7777
- 🛩️ A minimal view, for use as a fast-loading browser startpage
7878
- 🖱️ Choose app launch method, either new tab, same tab, a pop-up modal or in the workspace view
79-
- 📏 Customizable layout, sizes, text, component visibility, sort order, behavior etc
80-
- 🖼️ Option for full-screen background image, custom nav-bar links, html footer, title, etc
79+
- 📏 Customizable layout, sizes, text, component visibility, sort order, behavior etc.
80+
- 🖼️ Option for full-screen background image, custom nav-bar links, html footer, title, etc.
8181
- 🚀 Easy to setup with Docker, or on bare metal, or with 1-Click cloud deployment
8282
- ⚙️ Easy single-file YAML-based configuration, and option to configure app through the UI
8383
- ✨ Under active development with improvements and new features added regularly
8484
- 🤏 Small bundle size, fully responsive UI and PWA for basic offline access
8585
- 🆓 100% free and open source
8686
- 🔐 Strong focus on privacy
87-
- 🌈 Plus loads more...
87+
- 🌈 And loads more...
8888

8989
## Demo ⚡
9090

@@ -168,7 +168,7 @@ Dashy supports 1-Click deployments on several popular cloud platforms. To spin u
168168
169169
All of Dashy's configuration is specified in a single [YAML](https://yaml.org/) file, located at `./public/conf.yml`. You can find a complete list of available options in th [Configuring Docs](/docs/configuring.md). If you're using Docker, you'll probably want to pass this file in as a Docker volume (e.g. `-v /root/my-local-conf.yml:/app/public/conf.yml`).
170170

171-
The config can also be edited directly through the UI, with changes written to your conf.yml file. After making any modifications the app needs to be rebuilt, which will happen automatically or can be trigger with `yarn build` or directly through the UI.
171+
The config can also be edited directly through the UI with changes written to your conf.yml file. After making any modifications the app needs to be rebuilt, which will happen automatically or can be trigger with `yarn build` or directly through the UI.
172172

173173
You can check that your config is valid and matches Dashy's [schema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.json), by running: `yarn validate-config`.
174174

@@ -188,7 +188,7 @@ Finally, you may find these [example config](https://gist.github.com/Lissy93/000
188188
</a>
189189
</p>
190190

191-
Dashy comes with a number of built-in themes, but it's also easy to make you're own. You can either use the color editor, or you're own custom CSS. All colors, and most other CSS properties are specified using CSS variables, which are [documented here](./docs/theming.md#css-variables), so customizing the look and feel of Dashy very easy. Learn more about adding your own theme in the [docs](https://github.com/Lissy93/dashy/blob/master/docs/theming.md#adding-your-own-theme).
191+
Dashy comes with a number of built-in themes, but it's also easy to make your own. You can either use the color editor, or your own custom CSS. All colors, and most other CSS properties are specified using CSS variables, which are [documented here](./docs/theming.md#css-variables), thereby customizing the look and feel of Dashy. Learn more about adding your own theme in the [docs](https://github.com/Lissy93/dashy/blob/master/docs/theming.md#adding-your-own-theme).
192192

193193
<p align="center">
194194
<a href="https://i.ibb.co/cLDXj1R/dashy-theme-configurator.gif">

0 commit comments

Comments
 (0)