From a7b7c71d501d08dac3a708f5b0526947d6e0be89 Mon Sep 17 00:00:00 2001
From: tacotexmex <josefsahlberg+minetest@gmail.com>
Date: Thu, 31 Aug 2017 21:21:15 +0200
Subject: [PATCH] New readme

---
 README.md  | 33 +++++++++++++++++++++++++++++++++
 README.txt | 42 ------------------------------------------
 2 files changed, 33 insertions(+), 42 deletions(-)
 create mode 100644 README.md
 delete mode 100644 README.txt

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d81a294
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# item_drop
+By [PilzAdam](https://github.com/PilzAdam), [texmex](https://github.com/tacotexmex/).
+
+## Description
+This mod adds Minecraft like drop/pick up of items to Minetest.
+
+## Licensing
+LGPLv2.1/CC BY-SA 3.0.
+
+## Notes
+item_drop can be played with Minetest 0.4.16 or above. It was originally developed by [PilzAdam](https://github.com/PilzAdam/item_drop).
+
+## List of features
+- All settings may be configured from within the game itself (Settings tab > Advanced settings > Mods > item_drop)
+- Drops nodes as in-world items on dig if `enable_item_drop` is `true`. (true by default)
+- Pulls items to the player's inventory if `enable_item_pickup` is `true`. (true by default) It uses a node radius set in `pickup_radius` (default 0.75)
+- Plays a sound the items are picked up, with the gain level set it `pickup_gain` (default 0.4)
+- Requires a key to be pressed in order to pull items if `enable_item_pickup_key` is `true`. (true by default). The keytypes to choose from by setting `item_pickup_keytype` are:
+ - Use key (`Use`)
+ - Sneak key (`Sneak`)
+ - Left and Right keys combined (`LeftAndRight`)
+ - Right mouse button (`RMB`)
+ - Sneak key and right mouse button combined (`SneakAndRMB`)
+
+## Known issues
+
+## Bug reports and suggestions
+You can report bugs or suggest ideas by [filing an issue](http://github.com/tacotexmex/item_drop/issues/new).
+
+## Links
+* [Download ZIP](https://github.com/tacotexmex/item_drop/archive/master.zip)
+* [Source](https://github.com/tacotexmex/item_drop/)
+* [Forum thread](https://forum.minetest.net/viewtopic.php?t=16913)
diff --git a/README.txt b/README.txt
deleted file mode 100644
index fe43054..0000000
--- a/README.txt
+++ /dev/null
@@ -1,42 +0,0 @@
-===ITEM_DROP MOD for MINETEST-C55===
-by PilzAdam
-
-Introduction:
-This mod adds Minecraft like drop/pick up of items to Minetest.
-
-How to install:
-Unzip the archive an place it in minetest-base-directory/mods/minetest/
-if you have a windows client or a linux run-in-place client. If you have
-a linux system-wide instalation place it in ~/.minetest/mods/minetest/.
-If you want to install this mod only in one world create the folder
-worldmods/ in your worlddirectory.
-For further information or help see:
-http://wiki.minetest.com/wiki/Installing_Mods
-
-How to use the mod:
-Just install it an everything works.
-
-For developers:
-You dont have to use get_drops() anymore because of changes in the
-builtin files of minetest.
-
-License:
-Sourcecode: WTFPL (see below)
-Sound: WTFPL (see below)
-
-See also:
-http://minetest.net/
-
-         DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-                    Version 2, December 2004
-
- Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
-
- Everyone is permitted to copy and distribute verbatim or modified
- copies of this license document, and changing it is allowed as long
- as the name is changed.
-
-            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-  0. You just DO WHAT THE FUCK YOU WANT TO.