Skip to content

Commit

Permalink
Add README content
Browse files Browse the repository at this point in the history
 - very basic document structure and some links
  • Loading branch information
Esko Suomi committed Sep 29, 2017
1 parent 910b7e8 commit 52f73f2
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 21 deletions.
19 changes: 7 additions & 12 deletions .travis.yml
@@ -1,21 +1,16 @@
sudo: false
language: java
script: boot run-tests
language: clojure
install:
- mkdir -p ~/bin
- export PATH=~/bin:$PATH
# Could use `latest` tag instead of version number
- curl -L https://github.com/boot-clj/boot-bin/releases/download/2.7.2/boot.sh -o ~/bin/boot
- chmod +x ~/bin/boot
env:
matrix:
- BOOT_CLOJURE_VERSION=1.8.0
- SUB_PROJECT=library
- SUB_PROJECT=boot
- SUB_PROJECT=acceptance
jdk:
- oraclejdk8
cache:
directories:
- $HOME/.m2
- $HOME/.boot/cache/bin
- $HOME/.boot/cache/lib
- $HOME/bin

script:
- cd $SUB_PROJECT
- boot test
23 changes: 19 additions & 4 deletions README.md
@@ -1,10 +1,25 @@
# hedge
# Hedge · [![Join the chat at https://gitter.im/siilisolutions/hedge](https://badges.gitter.im/siilisolutions/hedge.svg)](https://gitter.im/siilisolutions/hedge?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.org/siilisolutions/hedge.svg?branch=master)](https://travis-ci.org/siilisolutions/hedge)

Hedge is a platform agnostic ClojureScript framework for deploying ring compatible handlers to various environments with focus on serverless deployments.

## Repository Contents

- [/library](/library) contains wrapping and transformation code for adapting handlers to various platforms
- [/boot](/boot) contains Hedge specific Boot tasks for code generation
- [/acceptance](/acceptance) contains Concordion based acceptance test suite which also works as technical documentation on how to use Hedge

## Known Limitations

- asynchronous ring handlers not yet supported

## Supported Platforms

### [Azure Functions](https://azure.microsoft.com/en-us/services/functions/)


[![Join the chat at https://gitter.im/siilisolutions/hedge](https://badges.gitter.im/siilisolutions/hedge.svg)](https://gitter.im/siilisolutions/hedge?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://travis-ci.org/siilisolutions/hedge.svg?branch=master)](https://travis-ci.org/siilisolutions/hedge)

## License

Copyright © 2016 [Siili Solutions Plc.](http://www.siili.com)
Copyright © 2016-2017 [Siili Solutions Plc.](http://www.siili.com)

Distributed under the [Eclipse Public License 1.0.](https://www.eclipse.org/legal/epl-v10.html)
2 changes: 1 addition & 1 deletion acceptance/boot.properties
Expand Up @@ -2,5 +2,5 @@
#Mon Dec 12 13:55:57 EET 2016
BOOT_CLOJURE_NAME=org.clojure/clojure
BOOT_CLOJURE_VERSION=1.8.0
BOOT_VERSION=2.6.0
BOOT_VERSION=2.7.2
BOOT_EMIT_TARGET=no
1 change: 1 addition & 0 deletions boot/README.md
@@ -0,0 +1 @@
# Hedge Boot Tasks · [![Clojars Project](https://img.shields.io/clojars/v/siili/boot-hedge.svg)](https://clojars.org/siili/boot-hedge)
2 changes: 1 addition & 1 deletion boot/boot.properties
Expand Up @@ -2,5 +2,5 @@
#Mon Dec 12 13:55:57 EET 2016
BOOT_CLOJURE_NAME=org.clojure/clojure
BOOT_CLOJURE_VERSION=1.8.0
BOOT_VERSION=2.6.0
BOOT_VERSION=2.7.2
BOOT_EMIT_TARGET=no
1 change: 1 addition & 0 deletions library/README.md
@@ -0,0 +1 @@
# Hedge Library · [![Clojars Project](https://img.shields.io/clojars/v/siili/hedge.svg)](https://clojars.org/siili/hedge)
2 changes: 1 addition & 1 deletion library/boot.properties
Expand Up @@ -2,5 +2,5 @@
#Mon Jan 02 15:54:26 EET 2017
BOOT_CLOJURE_NAME=org.clojure/clojure
BOOT_CLOJURE_VERSION=1.8.0
BOOT_VERSION=2.6.0
BOOT_VERSION=2.7.2
BOOT_EMIT_TARGET=no
3 changes: 1 addition & 2 deletions library/build.boot
@@ -1,6 +1,5 @@
(set-env!
:source-paths #{"src"}
:resource-paths #{"resources"}
:dependencies '[[adzerk/boot-cljs "1.7.228-2" :scope "test"]
[speclj "3.3.2" :scope "test"]
[org.clojure/clojurescript "1.9.908"]
Expand All @@ -22,7 +21,7 @@
(task-options!
pom {:project 'siili/hedge
:version +version+
:description "A serless framework fo cljs"
:description "A serverless framework fo cljs"
:url "https://github.com/siilisolutions/hedge"
:scm {:url "https://github.com/siilisolutions/hedge.git" :dir "../"}
:license {"EPL" "http://www.eclipse.org/legal/epl-v10.html"}})
Expand Down

0 comments on commit 52f73f2

Please sign in to comment.