Skip to content

fix: usage, readme markdown syntax #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
soulteary wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: usage, readme markdown syntax #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
jargo
======
# jargo

jargo is a simple library allowing access to information contained in a Java JAR file.


Expand Down Expand Up @@ -27,7 +27,8 @@ type JarInfo struct {
}
```

###Example Usage###
## Example Usage

Using Lucene analyzer jar file from: http://central.maven.org/maven2/org/apache/lucene/lucene-analyzers-stempel/5.0.0/lucene-analyzers-stempel-5.0.0.jar

```
Expand All @@ -40,15 +41,15 @@ import (
)

func main() {
err, manifest := jargo.GetManifest("lucene-analyzers-stempel-5.0.0.jar")
manifest, err := jargo.GetManifest("lucene-analyzers-stempel-5.0.0.jar")
if err != nil {
log.Fatal(err)
}
fmt.Println(manifest)

fmt.Println()

err, jar := jargo.GetJarInfo("lucene-analyzers-stempel-5.0.0.jar")
jar, err := jargo.GetJarInfo("lucene-analyzers-stempel-5.0.0.jar")
if err != nil {
log.Fatal(err)
}
Expand All @@ -63,7 +64,8 @@ Output:
&{Manifest:0xc20804c018 Files:[META-INF/ META-INF/MANIFEST.MF META-INF/services/ org/ org/apache/ org/apache/lucene/ org/apache/lucene/analysis/ org/apache/lucene/analysis/pl/ org/apache/lucene/analysis/stempel/ org/egothor/ org/egothor/stemmer/ META-INF/services/org.apache.lucene.analysis.util.TokenFilterFactory org/apache/lucene/analysis/pl/PolishAnalyzer$DefaultsHolder.class org/apache/lucene/analysis/pl/PolishAnalyzer.class org/apache/lucene/analysis/pl/stemmer_20000.tbl org/apache/lucene/analysis/pl/stopwords.txt org/apache/lucene/analysis/stempel/StempelFilter.class org/apache/lucene/analysis/stempel/StempelPolishStemFilterFactory.class org/apache/lucene/analysis/stempel/StempelStemmer.class org/egothor/stemmer/Cell.class org/egothor/stemmer/Compile.class org/egothor/stemmer/Diff.class org/egothor/stemmer/DiffIt.class org/egothor/stemmer/Gener.class org/egothor/stemmer/Lift.class org/egothor/stemmer/MultiTrie.class org/egothor/stemmer/MultiTrie2.class org/egothor/stemmer/Optimizer.class org/egothor/stemmer/Optimizer2.class org/egothor/stemmer/Reduce$Remap.class org/egothor/stemmer/Reduce.class org/egothor/stemmer/Row.class org/egothor/stemmer/Trie$StrEnum.class org/egothor/stemmer/Trie.class META-INF/LICENSE.txt META-INF/NOTICE.txt]}
```

###License###
## License

```
The MIT License (MIT)
Copyright (c) 2015 Glen Newton gnewton
Expand Down