Skip to content

Commit

Permalink
Add a note on where to ask questions or get help
Browse files Browse the repository at this point in the history
  • Loading branch information
ElMassimo committed Jan 24, 2021
1 parent c13820e commit 3bc83e5
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
</a>

<br>

<p align="center">
<a href="https://github.com/ElMassimo/vite_rails/actions">
<img alt="Build Status" src="https://github.com/ElMassimo/vite_rails/workflows/build/badge.svg"/>
Expand Down Expand Up @@ -41,6 +41,8 @@
[config file]: https://github.com/ElMassimo/vite_rails/blob/main/package/default.vite.json
[example app]: https://github.com/ElMassimo/vite_rails/tree/main/examples/blog
[heroku]: https://vite-rails-demo.herokuapp.com/
[Issues]: https://github.com/ElMassimo/vite_rails/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
[Discussions]: https://github.com/ElMassimo/vite_rails/discussions

[__Vite Rails__][vite_rails] allows you to use [Vite] to power the frontend of your Rails app.

Expand Down Expand Up @@ -94,6 +96,13 @@ Visit any page and you should see a printed console output: `Vite ⚡️ Rails`.

For more [guides] and a full [configuration reference], check the [documentation website][website].

## Contact ✉️

Please use [Issues] to report bugs you find, and [Discussions] to make feature requests or get help.

Don't hesitate to _⭐️ star the project_ if you find it useful!


## Special Thanks 🙏

- [webpacker]
Expand Down
8 changes: 8 additions & 0 deletions docs/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
[dev options]: /config/#development-options
[json config]: /config/#shared-configuration-file-%F0%9F%93%84
[vite config]: /config/#configuring-vite-%E2%9A%A1
[GitHub Issues]: https://github.com/ElMassimo/vite_rails/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
[GitHub Discussions]: https://github.com/ElMassimo/vite_rails/discussions

# Getting Started

Expand Down Expand Up @@ -73,3 +75,9 @@ Visit any page and you should see a printed console output: `Vite ⚡️ Rails`!
You can now start writing modern JavaScript apps with Vite! 😃

Check an [example app] running on [Heroku].

### Contact ✉️

Please visit [GitHub Issues] to report bugs you find, and [GitHub Discussions] to make feature requests, or to get help.

Don't hesitate to [⭐️ star the project][vite rails] if you find it useful!

0 comments on commit 3bc83e5

Please sign in to comment.