Skip to content

Commit ace2f37

Browse files
committed
simplifying the fdk repo readme along with mikes update
1 parent d85e3a1 commit ace2f37

1 file changed

Lines changed: 11 additions & 54 deletions

File tree

README.md

Lines changed: 11 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,23 @@
11
[![CircleCI](https://circleci.com/gh/fnproject/fdk-java.svg?style=svg&circle-token=348bec5610c34421f6c436ab8f6a18e153cb1c01)](https://circleci.com/gh/fnproject/fdk-java)
22

3-
# Fn Java Functions Developer Kit (FDK)
4-
The Java Function Developer Kit (FDK) makes it easy to deploy Java functions to Fn with full support for Java 11+ as the default out of the box.
3+
# Java Function Development Kit (FDK)
54

6-
## Install
7-
MacOS installation:
8-
```sh
9-
brew update && brew install fn
10-
```
5+
The Java Function Development Kit (FDK) makes it easy to build and deploy Java functions to Fn with full support for Java 11+ as the default out of the box.
116

12-
or
7+
Some of the Java FDK's features include:
138

14-
Alternatively for Linux/Unix/MacOS:
9+
- Parsing input and writing output
10+
- Flexible data binding to Java objects
11+
- Function testing using JUNit rules
12+
- And more!
1513

16-
```sh
17-
curl -LSs https://raw.githubusercontent.com/fnproject/cli/master/install | sh
18-
```
1914

20-
## General Information
21-
* See the Fn [Quickstart](https://github.com/fnproject/fn/blob/master/README.md) for sample commands.
22-
* [Detailed installation instructions](http://fnproject.io/tutorials/install/).
23-
* [Configure your CLI Context](http://fnproject.io/tutorials/install/#ConfigureyourContext).
24-
* For a list of commands see [Fn CLI Command Guide and Reference](https://github.com/fnproject/docs/blob/master/cli/README.md).
25-
* For general information see Fn [docs](https://github.com/fnproject/docs) and [tutorials](https://fnproject.io/tutorials/).
15+
## Using the Java FDK
2616

27-
## Fn Java FDK Development Information
28-
### Contributing
29-
Please see [CONTRIBUTING.md](CONTRIBUTING.md).
30-
31-
### Fn Java FDK FAQ
32-
Some common questions are answered in [our FAQ](docs/FAQ.md).
33-
34-
### Fn Java FDK Tutorials and Examples
35-
36-
#### Examples
37-
Check out Java FDK examples in the [`examples`](examples) directory for
38-
functions demonstrating different Fn Java FDK features.
17+
For detailed instructions on using the Java FDK to build and deploy Java functions to Fn, please see the official Java FDK developer guide in our docs repo here: https://github.com/fnproject/docs/blob/master/fdks/fdk-java/README.md.
3918

40-
#### Configuring your Function
41-
Want to set up function object state before the function is invoked using external configuration variables? Have a look at the [Function
42-
Configuration](docs/FunctionConfiguration.md) tutorial.
19+
## Contributing to the Java FDK
4320

44-
#### Handling HTTP Requests
45-
Want to access HTTP details such as request or response headers or the HTTP status? Check out [Accessing HTTP Information from Functions](docs/HTTPGatewayFunctions.md).
46-
47-
#### Input and Output Bindings
48-
You have the option of taking more control of how serialization and
49-
deserialization is performed by defining your own bindings.
50-
51-
See the [Data Binding](docs/DataBinding.md) tutorial for other out-of-the-box
52-
options and the [Extending Data Binding](docs/ExtendingDataBinding.md) tutorial
53-
for how to define and use your own bindings.
54-
55-
#### Asynchronous Workflows
56-
Suppose you want to call out to some other function from yours - perhaps
57-
a function written in a different language, or even one maintained by
58-
a different team. Maybe you then want to do some processing on the result. Or
59-
even have your function interact asynchronously with a completely different
60-
system. Perhaps you also need to maintain some state for the duration of your
61-
function, but you don't want to pay for execution time while you're waiting for
62-
someone else to do their work.
21+
Please see [CONTRIBUTING.md](CONTRIBUTING.md).
6322

64-
If this sounds like you, then have a look at the [Fn Flow
65-
Quickstart](docs/FnFlowsUserGuide.md).
6623

0 commit comments

Comments
 (0)