Skip to content

Commit cffb955

Browse files
authored
README fix (#6)
* README fix * added HTTPS to website
1 parent 0c52813 commit cffb955

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

+16-7
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ This is the monorepo for Flash Calendar, an incredibly fast and flexible library
66

77
<img src="./apps/docs/static/img/cover.png" width="800px"/>
88

9-
## Contributing
9+
## Documentation & Examples
10+
11+
You can find the Flash Calendar documentation [on the website](https://marceloprado.github.io/flash-calendar/).
12+
13+
## Installation
1014

1115
This project uses [Bun](https://bun.sh/) as its package manager. The first thing you'll need is to [install Bun](https://bun.sh/).
1216

@@ -34,27 +38,32 @@ To run the documentation website:
3438
bun docs
3539
```
3640

37-
### Making changes
41+
## Contributing
3842

39-
Ensure your chagens are unit-tested. To improve DX, run the tests in watch mode with `bun test --watch`. You can also run the tests for a specific file with `bun test --watch {filename}`.
43+
Ensure your changes are unit-tested. To improve DX, run the tests in watch mode with `bun test --watch`. You can also run the tests for a specific file with `bun test --watch {filename}`.
4044

41-
#### Package structure
45+
### Package structure
4246

43-
##### /apps
47+
#### /apps
4448

4549
- `/apps/example`: Storybook host for Flash Calendar, runs with the latest uncompiled code.
4650
- `/apps/docs`: The documentation website for Flash Calendar.
4751

48-
##### /kitchen-sink
52+
#### /kitchen-sink
4953

5054
A place to test the published Flash Calendar in a real environment.
5155

5256
- `/kitchen-sink/expo`: Scaffolded expo project to test the flash calendar in a real environment.
5357

54-
##### /packages
58+
#### /packages
5559

5660
The actual src code for Flash Calendar:
5761

5862
- `/packages/flash-calendar`: The flash calendar package itself.
5963
- `/packages/eslint-config`: Shared eslint config for the project.
6064
- `/packages/tsconfig`: Shared tsconfig for the project.
65+
66+
67+
### License
68+
69+
Flash Calendar is [MIT licensed](./LICENSE).

0 commit comments

Comments
 (0)