commit 766c6a91464b8c290713f5b52f4548553932496c
parent a5bac7d426f9dd549635693fbb3c3fbf39e52303
Author: Paco Esteban <paco@onna.be>
Date: Mon, 29 Jul 2019 10:37:25 +0200
add license and readme
Diffstat:
| A | LICENSE | | | 13 | +++++++++++++ |
| A | README | | | 39 | +++++++++++++++++++++++++++++++++++++++ |
2 files changed, 52 insertions(+), 0 deletions(-)
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,13 @@
+Copyright 2019 Paco Esteban
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
diff --git a/README b/README
@@ -0,0 +1,39 @@
+# geoloc
+
+## description
+
+`geoloc` is a small utility to get geolocalization information given an ip
+address.
+
+It's written in C and uses [libcurl][1] and [json-c][2] do do its job.
+
+## installation
+
+```
+make
+make install # with enough privileges
+```
+
+You'll need `libcurl` and `json-c` on the _"usual locations"_
+
+If you need to make some adjustments, take a look at the `Makefile`, is
+quite simple.
+
+## disclaimer
+
+This is a personal project to play with C. It is definitely not ready for any
+kind of production use. This is a toy.
+
+## license
+
+Distributed under the [ISC][3] license
+
+## bugs
+
+Probably more than lines of code.
+Patches are welcome. Send them to <gitpatch-geoloc@onna.be>
+
+---
+[1]: https://curl.haxx.se/libcurl/
+[2]: https://github.com/json-c/json-c
+[3]: https://opensource.org/licenses/ISC
