Skip to content

Commit 173553e

Browse files
authored
📜 Update README.md
rearrange badges and update text
1 parent 055d69b commit 173553e

File tree

1 file changed

+11
-15
lines changed

1 file changed

+11
-15
lines changed

README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
1-
# 🧭 Compass
2-
3-
![Build](https://github.com/SwitchbackTech/compass/actions/workflows/test.yml/badge.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
1+
# 🧭 Compass Calendar
42

53
## Overview
64

7-
### _Compass is a weekly calendar app that integrates with Google Calendar._
5+
_Compass is a weekly calendar app that integrates with Google Calendar._
6+
7+
![Build](https://github.com/SwitchbackTech/compass/actions/workflows/test.yml/badge.svg)
8+
9+
![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB) ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white) ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white) ![Google Cloud](https://img.shields.io/badge/GoogleCloud-%234285F4.svg?style=for-the-badge&logo=google-cloud&logoColor=white) ![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white) ![Redux](<https://img.shields.io/badge/redux-%23593d88.svg?style=for-the-badge&logo=redux&logoColor=white![Express.js](https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB)>) ![Socket.io](https://img.shields.io/badge/Socket.io-black?style=for-the-badge&logo=socket.io&badgeColor=010101)
10+
![Webpack](https://img.shields.io/badge/webpack-%238DD6F9.svg?style=for-the-badge&logo=webpack&logoColor=black) ![Yarn](https://img.shields.io/badge/yarn-%232C8EBB.svg?style=for-the-badge&logo=yarn&logoColor=white) ![Styled Components](https://img.shields.io/badge/styled--components-DB7093?style=for-the-badge&logo=styled-components&logoColor=white)
11+
![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white)
12+
![Testing-Library](https://img.shields.io/badge/-TestingLibrary-%23E33332?style=for-the-badge&logo=testing-library&logoColor=white)
813

914
![Compass_Highlights](https://github.com/SwitchbackTech/compass/assets/30163055/00543d34-5dfc-47d5-9b83-d84d4c748391)
1015

1116
## Features
1217

13-
Here are the main features:
14-
1518
- 🔄 2-way sync with Google Calendar
1619
- 🔄 Recurring events
1720
- ⚡ Command palette
@@ -30,15 +33,15 @@ Visit [app.compasscalendar.com](https://app.compasscalendar.com) to see them all
3033
## Limitations
3134

3235
This calendar is a work in progress that might not have everything
33-
you need, including:
36+
you need yet, including:
3437

3538
- Sub-calendars (only primary calendar is supported)
3639
- Sharing
3740
- Location
3841
- Reminders
3942
- Mobile app
4043

41-
## Setup & Guides
44+
## Documentation
4245

4346
All the docs are at [docs.compasscalendar.com](https://docs.compasscalendar.com), including guides on how to install, test, build, deploy, and contribute
4447

@@ -53,10 +56,3 @@ All the docs are at [docs.compasscalendar.com](https://docs.compasscalendar.com)
5356
🎬 [Compass on YouTube](https://youtube.com/playlist?list=PLPQAVocXPdjmYaPM9MXzplcwgoXZ_yPiJ&si=jssXj_g9kln8Iz_w)
5457

5558
[Compass Blog](https://www.compasscalendar.com/post/compass-is-open-source)
56-
57-
## Built with ☕️ and this stack
58-
59-
![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB) ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white) ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white) ![Google Cloud](https://img.shields.io/badge/GoogleCloud-%234285F4.svg?style=for-the-badge&logo=google-cloud&logoColor=white) ![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white) ![Redux](<https://img.shields.io/badge/redux-%23593d88.svg?style=for-the-badge&logo=redux&logoColor=white![Express.js](https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB)>) ![socket.io](https://img.shields.io/badge/SOCKET.IO-black?logo=socketdotio)
60-
![Webpack](https://img.shields.io/badge/webpack-%238DD6F9.svg?style=for-the-badge&logo=webpack&logoColor=black) ![Yarn](https://img.shields.io/badge/yarn-%232C8EBB.svg?style=for-the-badge&logo=yarn&logoColor=white) ![Styled Components](https://img.shields.io/badge/styled--components-DB7093?style=for-the-badge&logo=styled-components&logoColor=white)
61-
![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white)
62-
![Testing-Library](https://img.shields.io/badge/-TestingLibrary-%23E33332?style=for-the-badge&logo=testing-library&logoColor=white)

0 commit comments

Comments
 (0)