Skip to content

Commit ada6435

Browse files
author
Juan Pablo Civile
committed
Add nice things that reflect we use github
1 parent 1f52fe0 commit ada6435

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed

README.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Anviz TCP Protocol
2+
3+
This library allows you to communicate with your Anviz device from Java. Right now it supports a limited set of features, but is easily extensible to suit your needs.
4+
5+
# Adding the dependency
6+
7+
We use [Maven](http://maven.apache.org/) for building & distributing our libraries. You're welcome to use our Maven repositories, or build your own .jar.
8+
9+
To use our Maven repos just add:
10+
11+
<repositories>
12+
<repository>
13+
<id>monits-snapshots</id>
14+
<url>http://nexus.monits.com/content/repositories/oss-snapshots/</url>
15+
<name>Monits Snapshots</name>
16+
</repository>
17+
</repositories>
18+
19+
<dependencies>
20+
<dependency>
21+
<groupId>com.monits</groupId>
22+
<artifactId>anviz-protocol</artifactId>
23+
<version>1.0-SNAPSHOT</version>
24+
</dependency>
25+
</dependencies>
26+
27+
To build a .jar from source:
28+
29+
>
30+
> mvn clean install
31+
>
32+
33+
# Usage
34+
35+
Just check out the `TimeKeeper` class, it doesn't hold any secrets.
36+
37+
# Contributing
38+
39+
We encourage you to contribute to this project!
40+
41+
We are also looking forward to your bug reports, feature requests and questions.
42+
43+
# Copyright and License
44+
45+
Copyright 2012 Monits.
46+
47+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License at:
48+
49+
http://www.apache.org/licenses/LICENSE-2.0
50+

pom.xml

+9
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,15 @@
2929
</license>
3030
</licenses>
3131

32+
<scm>
33+
<developerConnection>scm:git:[email protected]:Monits/Anviz-Protocol.git</developerConnection>
34+
<url>http://github.com/Monits/Anviz-Protocol</url>
35+
</scm>
36+
<issueManagement>
37+
<system>Github Issue Tracker</system>
38+
<url>https://github.com/Monits/Anviz-Protocol/issues</url>
39+
</issueManagement>
40+
3241
<repositories>
3342
<repository>
3443
<id>monits-external</id>

0 commit comments

Comments
 (0)