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.

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

Updated/fixed some documentation #9

Merged
merged 1 commit into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added .github/images/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/screenshot2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 3 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,9 @@ This plugin uses [Gulp](http://gulpjs.com/) to build its resources.
| release-all | Builds all release resources and copy to graisl2 and grails3.|

## File structure

.
├── grails2
│ ├── app # grails2 test app
│ └── plugin # grails2 plugin
├── grails3
│ ├── app # grails3 test app
│ └── plugin # grails3 plugin
│── app # test app
│── plugin # plugin
├── web # shared web resources
│ ├── app # coffeescript
│ ├── img
Expand All @@ -42,6 +37,6 @@ This plugin uses [Gulp](http://gulpjs.com/) to build its resources.

## Running

When developing, use `grails2/app` and `grails3/app`.
When developing, use `app`


4 changes: 2 additions & 2 deletions LOCALDEPLOYMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ This page is meant for people not willing to wait for an official plugin release
### Build

```shell
npm run grails3:release
npm run grails:release

cd grails3/plugin
cd plugin

./gradlew clean
./gradlew build
Expand Down
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
[![Java CI](https://github.com/gpc/grails-web-console/actions/workflows/gradle.yml/badge.svg)](https://github.com/gpc/grails-web-console/actions/workflows/gradle.yml)

# Grails Web Console

## Summary
A web-based Groovy console for interactive runtime application management and debugging

![Screenshot](https://raw.github.com/gpc/grails-web-console/images/screenshot.png)
![Screenshot](.github/images/screenshot.png)

## Versions

Expand All @@ -23,7 +27,7 @@ repositories {
}

dependencies {
compile 'com.github.gpc:grails-web-console:7.0.0-SNAPSHOT'
runtimeOnly 'com.github.gpc:grails-web-console:7.0.0-SNAPSHOT'
}
```

Expand Down Expand Up @@ -57,7 +61,7 @@ Calls made to the implicit `console` variable will be executed on the browser's
The arguments are serialized as JSON and the calls are queued to run after the script completes.

Example:
![Screenshot](https://raw.github.com/gpc/grails-web-console/images/screenshot2.png)
![Screenshot](.github/images/screenshot2.png)

## Implicit variables

Expand Down Expand Up @@ -128,6 +132,9 @@ grails.plugin.springsecurity.controllerAnnotations.staticRules = [
* [Mike Hugo](https://github.com/mjhugo)
* [Kamil Dybicz](https://github.com/kdybicz)
* [Sachin Verma](https://github.com/vsachinv)
* [James Daugherty](https://github.com/jdaugherty)
* [Scott Murphy](https://github.com/codeconsole)
* [Søren Berg Glasius](https://github.com/sbglasius)

## Development

Expand Down
Loading