Skip to content
This repository has been archived by the owner on Jan 31, 2023. It is now read-only.

Commit

Permalink
Merge pull request #10 from jxnblk/update-readme
Browse files Browse the repository at this point in the history
Add list of supported apps to readme
  • Loading branch information
jxnblk authored Jun 6, 2018
2 parents 47b5031 + e28ed6d commit ba9b0e7
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,15 @@ Download for MacOS:

[download]: https://github.com/jxnblk/ram/releases/latest

RAM includes support for the following app types:

- [Create React App][cra]
- [Next.js][nextjs]
- [Gatsby][gatsby]
- [Razzle][razzle]
- [Vue.js][vuejs]

To add support for another app, please [open a pull request](#contributing).

## Motivation

Expand Down Expand Up @@ -62,7 +71,6 @@ Some alternatives to this particular Electron setup include:
- Requires Node.js v6+ and npm v5.2+
- Built in a few hours
- No tests
- Expects the port to be `3000`
- Not tested on Linux or Windows


Expand All @@ -77,10 +85,8 @@ Some alternatives to this particular Electron setup include:
## Roadmap

- [ ] Abstract create form to a more general purpose utility
- [ ] Refactor React component architecture where needed
- [ ] Configurable `port` option
- [ ] npm depencendy management
- [ ] Add support for [create-next-app](https://github.com/segmentio/create-next-app), [gatsby-cli](https://github.com/gatsbyjs/gatsby), etc.
- [ ] Preact CLI support

## Contributing

Expand Down Expand Up @@ -112,3 +118,8 @@ No Babel transpilation is used, so be sure to use Electron-compatible modules an
[pkg]: https://github.com/zeit/pkg
[sandbox]: https://codesandbox.io

[nextjs]: https://github.com/zeit/next.js/
[create-next-app]: https://github.com/segmentio/create-next-app
[gatsby]: https://github.com/gatsbyjs/gatsby
[razzle]: https://github.com/jaredpalmer/razzle
[vuejs]: https://github.com/vuejs/vue

0 comments on commit ba9b0e7

Please sign in to comment.