Skip to content

Commit

Permalink
update front facing README
Browse files Browse the repository at this point in the history
  • Loading branch information
jchip committed Jun 14, 2017
1 parent 6f8fdde commit 262dbd6
Showing 1 changed file with 23 additions and 50 deletions.
73 changes: 23 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,79 +13,52 @@
Read the [Announcement Blog] Post.

# Getting Started

- [Getting Started with Electrode](https://electrode.gitbooks.io/electrode/content/chapter1/quick-start/get-started.html)
Visit our site at <http://www.electrode.io>.

- [Electrode Site](http://www.electrode.io)
See the [README.md in docs](/docs/README.md) or visit our [gitbook documents].

- [Docs](https://electrode.gitbooks.io/electrode/content/overview/what-is-electrode.html)

## Report a bug or request a feature
# Getting Started

https://github.com/electrode-io/electrode/issues
- [Getting Started with Electrode](https://electrode.gitbooks.io/electrode/content/chapter1/quick-start/get-started.html)

## Report an issue or help out with the docs
# Documentation

https://github.com/electrode-io/electrode-io.github.io/issues
The documents for Electrode are maintained as [gitbook documents] in the [docs](/docs) directory.

Check [gitbook] for more info about gitbook.

# Packages

This repo uses [Lerna] to manage multiple related packages that are part of the Electrode Core.

## App Archetype

[electrode-archetype-react-app] is a NPM module that provides for common patterns across all app projects so that each app project can standardize on common development behavior and patterns. Its essentially pre-made patterns for build scripts. It also requires a companion module [electrode-archetype-react-app-dev] that's meant for your app's `devDependencies`.

## Yeoman Generator

The Yeoman [generator-electrode] NPM module allows you to quickly create an Universal React App with support from the app archetype, and server in Node with Hapi or Express.
# Contributing

# Sample Applications
Please see the [CONTRIBUTING guide](/CONTRIBUTING.md)

Some sample applications can be found under the [`samples`](samples) directory.

# Docs
Built with :heart: by [Team Electrode] @WalmartLabs.

Electrode platform creates and hosts books under [`docs`](docs) directory. It contains the full documentation of electrode, generated using GitBook.
[team electrode]: https://github.com/orgs/electrode-io/people

See [Gitbook Toolchain](https://toolchain.gitbook.com/) for more details.
[announcement blog]: https://medium.com/walmartlabs/introducing-electrode-an-open-source-release-from-walmartlabs-14b836135319#.pwbddxg1z

## Boilerplate Universal React Node
[material-ui]: http://www.material-ui.com

Under [`samples/universal-react-node`](samples/universal-react-node) is a sample Electrode app that was created with the Electrode generator and consumes the Electrode App archetype modules. We've added other demos and features to it to serve as examples. It demonstrates usage with the following Electrode modules:
[lerna]: https://lernajs.io/

- [Electrode Confippet](https://github.com/electrode-io/electrode-confippet)
- [Electrode Electrify](https://github.com/electrode-io/electrify)
- [Electrode CSRF JWT](https://github.com/electrode-io/electrode-csrf-jwt)
- [Electrode Redux Router Engine](https://github.com/electrode-io/electrode-redux-router-engine)
- [Electrode React SSR Caching](https://github.com/electrode-io/electrode-react-ssr-caching)
- [Above The Fold Only Server Render](https://github.com/electrode-io/above-the-fold-only-server-render)
- [Electrode Bundle Analyzer](https://github.com/electrode-io/electrode-bundle-analyzer)
[electrode-archetype-react-app]: packages/electrode-archetype-react-app

See its [README](samples/universal-react-node/README.md) for more details.
[electrode-archetype-react-app-dev]: packages/electrode-archetype-react-app-dev

## Sample Universal React Node with [material-ui]
[generator-electrode]: packages/generator-electrode

Under [`samples/universal-material-ui`](samples/universal-material-ui) is a sample Electrode app that uses the [material-ui] React components.
[travis-image]: https://travis-ci.org/electrode-io/electrode.svg?branch=master

See its [README](samples/universal-material-ui/README.md) for more details.
[travis-url]: https://travis-ci.org/electrode-io/electrode

# More Samples
[daviddm-image]: https://david-dm.org/electrode-io/electrode/dev-status.svg

We have more separate Electrode Sample Apps at https://github.com/electrode-samples that you can use as references.
[daviddm-url]: https://david-dm.org/electrode-io/electrode?type=dev

Built with :heart: by [Team Electrode] @WalmartLabs.
[gitbook]: https://www.gitbook.com/

[Team Electrode]: https://github.com/orgs/electrode-io/people
[Announcement Blog]: https://medium.com/walmartlabs/introducing-electrode-an-open-source-release-from-walmartlabs-14b836135319#.pwbddxg1z
[material-ui]: http://www.material-ui.com
[Lerna]: https://lernajs.io/
[electrode-archetype-react-app]: packages/electrode-archetype-react-app
[electrode-archetype-react-app-dev]: packages/electrode-archetype-react-app-dev
[generator-electrode]: packages/generator-electrode
[travis-image]: https://travis-ci.org/electrode-io/electrode.svg?branch=master
[travis-url]: https://travis-ci.org/electrode-io/electrode
[daviddm-image]: https://david-dm.org/electrode-io/electrode/dev-status.svg
[daviddm-url]: https://david-dm.org/electrode-io/electrode?type=dev
[gitbook documents]: https://electrode.gitbooks.io/electrode/content/overview/what-is-electrode.html

0 comments on commit 262dbd6

Please sign in to comment.