Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 64 lines (52 sloc) 1.996 kb
b2df4d3 @dreverri Add basic readme
dreverri authored
1 * webmachine
2 ** Overview
3 Webmachine is an application layer that adds HTTP semantic awareness
4 on top of the excellent bit-pushing and HTTP syntax-management
5 provided by mochiweb, and provides a simple and clean way to connect
6 that to your application's behavior.
7
d25987a @justinsheehy switched webmachine.basho.com link from https to http
justinsheehy authored
8 More information is available [[http://webmachine.basho.com/][here]].
b2df4d3 @dreverri Add basic readme
dreverri authored
9
10 ** Quick Start
11 A shell script is provided in the =webmachine= repository to help
12 users quickly and easily create a new =webmachine= application.
13
14 #+BEGIN_SRC shell
15 git clone git://github.com/basho/webmachine.git
16 cd webmachine
17 ./scripts/new_webmachine.sh mydemo
18 #+END_SRC
19
20 A destination path can also be passed to the =new_webmachine.sh=
21 script.
22
23 #+BEGIN_SRC shell
24 ./scripts/new_webmachine.sh mydemo ~/webmachine_applications
25 #+END_SRC
26
27 Once a new application has been created it can be built and started.
28
29 #+BEGIN_SRC shell
30 cd mydemo
31 make
32 ./start.sh
33 #+END_SRC
34
35 The application will be available at [[http://localhost:8000]].
36
37 To learn more continue reading [[https://webmachine.basho.com/][here]].
38
39 ** Contributing
40 We encourage contributions to =webmachine= from the community.
41
42 1) Fork the =webmachine= repository on [[https://github.com/basho/webmachine][Github]].
43 2) Clone your fork or add the remote if you already have a clone of
44 the repository.
45 #+BEGIN_SRC shell
46 git clone git@github.com:yourusername/webmachine.git
47 # or
48 git remote add mine git@github.com:yourusername/webmachine.git
49 #+END_SRC
50 3) Create a topic branch for your change.
51 #+BEGIN_SRC shell
52 git checkout -b some-topic-branch
53 #+END_SRC
54 4) Make your change and commit. Use a clear and descriptive commit
55 message, spanning multiple lines if detailed explanation is
56 needed.
57 5) Push to your fork of the repository and then send a pull-request
58 through Github.
59 #+BEGIN_SRC shell
60 git push mine some-topic-branch
61 #+END_SRC
62 6) A Basho engineer or community maintainer will review your patch
63 and merge it into the main repository or send you feedback.
Something went wrong with that request. Please try again.