Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bsorrentino committed Feb 12, 2018
1 parent 5d5781c commit f72640d
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,34 @@

Java Processor to **generate [Typescript](https://www.typescriptlang.org/) Definition file (.d.ts)** from whatever Java classes.

### What is it for ?
## What is it for ?

This is to help developing on **JVM javascript engine** (ie [Nashorn](http://www.oracle.com/technetwork/articles/java/jf14-nashorn-2126515.html)/[Rhino](https://github.com/mozilla/rhino)) using [Typescript](https://www.typescriptlang.org/)

The main goal is having the definitions available in the modern IDE like [Visual Studio Code](https://code.visualstudio.com/) and [Atom](https://atom.io/) and then use the **intellisense** feature available for java classes within typescript

### What is it not for ?
## What is it not for ?

It is not a transpiler from Java to Javascript like [datathings/java2typescript](https://github.com/datathings/java2typescript)

## Similar projects

### Getting Started
* [typescript-generator](https://github.com/vojtechhabarta/typescript-generator)

## Related Project

* [jvm-npm](https://github.com/bsorrentino/jvm-npm)

## Getting Started

### Use Maven Archetype

#### interactive mode
```
mvn archetype:generate \
-DarchetypeGroupId=org.bsc.processor \
-DarchetypeArtifactId=java2ts-processor-archetype \
-DarchetypeVersion=${project.version}
```

_Coming Soon ..._

0 comments on commit f72640d

Please sign in to comment.