Skip to content

Commit 3727627

Browse files
doc: update readme, contributing and license
1 parent a660d11 commit 3727627

File tree

4 files changed

+19
-31
lines changed

4 files changed

+19
-31
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
# Running tests
1+
If you want to contribute, join us on the Discord channel and let's figure it out!
22

3-
### test with Jest and Prettier
4-
```
5-
npm run test
6-
```
7-
8-
### test with Jest only
9-
```
10-
npm run test
11-
```
12-
13-
### test specific project or test in watch mode
14-
*See jest.config.js for projects*
15-
```
16-
npm run test:jest -- --watch --testMatch **/filemapper-overlay.test.js --selectProjects unit
17-
```
3+
Later on we will have more extensive contributing guidelines.

LICENSE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright <2025> <Team Routify>
2+
3+
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:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
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.

README.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,20 @@
1-
# Routify 3
1+
<div align="center">
2+
<img src="routify.png" alt="routify" width="512" /><br>
3+
<img src="https://badgen.net/npm/v/@roxi/routify" alt="Badge" />
4+
</div>
25

3-
4-
## Install
6+
# Install
57

68
Create a new Routify project with
79

810
npm init routify@latest
911

10-
## Using Routify
11-
12-
#### Creating a router
12+
# Documentation
1313

14-
Basic
14+
[routify.dev](https://routify.dev/guide/introduction)
1515

16-
```html
17-
<script>
18-
import { Router } from '@roxi/routify'
19-
import routes from '../.routify/routes.default.js'
20-
</script>
16+
# Support
2117

22-
<Router {routes} />
23-
```
18+
- Please feel free to open an [issue](https://github.com/roxiness/routify/issues/new/choose) or a [pull request](https://github.com/roxiness/routify/fork). All feedback is welcome!
2419

25-
[Docs](https://v3.routify.dev/)
20+
- You can join the [Routify Discord](https://discord.gg/ntKJD5B)

routify.png

38.1 KB
Loading

0 commit comments

Comments
 (0)