Moving things to the root directory.

.github/workflows/test.yml

@@ -0,0 +1,33 @@
+# This workflow will build a Java project with Gradle
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle
+
+name: Run CI tests with Gradle
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        java: 
+          - 11
+          - 17
+          # We need 2.12.0 at minimum for JDK 21.0.2
+          - 21.0.1 
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup Java ${{ matrix.java }}
+      uses: actions/setup-java@v1
+      with:
+        java-version: ${{ matrix.java }}
+        distribution: 'temurin'
+
+    - name: Grant execute permission for gradlew
+      run: chmod +x gradlew
+    - name: Build with Gradle
+      run: ./gradlew -Dtests.security.manager=false clean test

.gitignore

@@ -1,4 +1,13 @@
-build/
-target/
-*.zip
+# Ignore Gradle project-specific cache directory
+.gradle
 
+# Ignore Gradle build output directory
+build
+
+# intellij files
+.idea/
+*.iml
+*.ipr
+*.iws
+build-idea/
+out/

README.md

@@ -1,3 +1,31 @@
-# OpenSearch Relevance
+# search-relevance-plugin
 
-Playground and sandbox for the OpenSearch relevance work.
+Build the plugin.  Note that you will have to match up the JDK 11 on your system to java home in the `gradle.properties` file:
+
+`./gradlew build`
+
+Build the OpenSearch docker image and add the plugin:
+
+`docker compose build`
+
+Start the containers:
+
+`docker compose up`
+
+Initialize the `awesome` search relevance index:
+
+```
+curl -X PUT http://localhost:9200/_plugins/search_relevance/awesome
+```
+
+Send an event to the `awesome` store:
+
+```
+curl -X POST http://localhost:9200/_plugins/search_relevance/awesome -H "Content-Type: application/json" -d @instant-search.json
+```
+
+Get events:
+
+```
+curl http://localhost:9200/.awesome_events/_search
+```