Skip to content

Commit c797011

Browse files
authored
Add MIT license, document generator provenance (#308)
* Add MIT license * Document generator provenance in README
1 parent 80f21f1 commit c797011

2 files changed

Lines changed: 35 additions & 1 deletion

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Svyatoslav Kryukov
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,19 @@
22

33
A modern full-stack starter application with Rails backend and React frontend using Inertia.js based on the [Laravel Starter Kit](https://github.com/laravel/react-starter-kit).
44

5+
## About this repo
6+
7+
This starter kit is generated output of [inertia-rails/generator](https://github.com/inertia-rails/generator):
8+
each generator release regenerates the app and opens an automated sync PR here, so most files in this repo
9+
are overwritten on every sync. **To contribute changes to the app itself, open a PR against the generator**
10+
only this README and the deploy workflow are kit-owned.
11+
12+
Prefer different options (framework, JavaScript instead of TypeScript, feature set)? Generate your own app:
13+
14+
```sh
15+
rails new myapp -m https://raw.githubusercontent.com/inertia-rails/generator/dist/template.rb
16+
```
17+
518
## Features
619

720
- [Inertia Rails](https://inertia-rails.dev) & [Vite Rails](https://vite-ruby.netlify.app) setup
@@ -63,4 +76,4 @@ for production images.
6376

6477
## License
6578

66-
The project is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
79+
The project is available as open source under the terms of the [MIT License](LICENSE).

0 commit comments

Comments
 (0)