Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README #810

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README #810

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
633ac2e
Update README
QubitPi May 8, 2019
f0d2239
Merge branch 'master' into update-README
QubitPi May 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ To expose these models, follow the steps documented in [elide-standalone](https:

```java
public class YourMain {
public static void main(String[] args) {
public static void main(String[] args) throws Exception {

ElideStandaloneSettings settings = new ElideStandaloneSettings() {

Expand Down
6 changes: 4 additions & 2 deletions elide-standalone/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To actually start your Elide application, add the following to your main method:

```java
public class Main {
public static void main(String[] args) {
public static void main(String[] args) throws Exception {
Copy link
Collaborator

@DennisMcWherter DennisMcWherter May 9, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rather than adding the unchecked exception to the signature, I would suggest adding it to the javadoc. Especially since this is on the main method, there is no one else to really catch it.

Same comment for the others.

ElideStandalone elide = new ElideStandalone(new ElideStandaloneSettings() {
@Override
public String getModelPackageName() {
Expand All @@ -59,6 +59,8 @@ Below we'll walk through a complete example of setting up an Elide service witho

**If you're interested in seeing a more complete example, check out our [ready-to-run example](https://github.com/DennisMcWherter/elide-example-blog-kotlin).**

You could also get a quicker experience of Elide using our [Docker image for this application](https://hub.docker.com/r/liujiaqi/elide-quick)

### Setup a Database (MySQL)

In our example, we will suggest your create a MySQL database called `elide` that is accessible to the user `elide` with password `elide123`.
Expand Down Expand Up @@ -172,7 +174,7 @@ To start Elide, just run the `start()` method somewhere in your main function:

```java
public class YourMain {
public static void main(String[] args) {
public static void main(String[] args) throws Exception {
ElideStandalone elide = new ElideStandalone(new ElideStandaloneSettings() {
@Override
public String getModelPackageName() {
Expand Down
2 changes: 1 addition & 1 deletion translations/zh/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ public class Book {

```java
public class YourMain {
public static void main(String[] args) {
public static void main(String[] args) throws Exception {

ElideStandaloneSettings settings = new ElideStandaloneSettings() {

Expand Down