Move code into subdirectory

1 files changed, 50 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100755
index 0000000..2bffa25
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+#Owncloud Antivirus App   
+
+files_antivirus is an antivirus app for [Owncloud](https://github.com/owncloud) based on [ClamAV](http://www.clamav.net).
+
+v0.2
+
+##Details
+
+The idea is to check for virus at upload-time, notifying the user (on screen and/or email) and
+remove the file if it's infected.
+
+##Status
+
+The App is not complete yet...
+* It can be configured to work with the executable or the daemon mode of ClamAV
+* In daemon mode, it sends files to a remote/local server using INSTREAM command
+* When the user uploads a file, it's checked
+* If an uploaded file is infected, it's deleted and a notification is shown to the user on screen and an email is sent with details.
+* Tested in Linux only
+
+##In progress
+
+* Test uploading from clients
+
+##ToDo
+
+* Background Job to scan all files
+* File size limit
+* Configurations Tuneups
+* Other OS Testing
+* Look for ideas :P
+
+## Requirements
+
+* Owncloud 4
+* ClamAV (Binaries or a server running ClamAV in daemon mode)
+
+## Install
+
+* Download App tarball or clone repo
+ * [master](https://github.com/valarauco/files_antivirus/tarball/master)
+ * [v0.2](https://github.com/valarauco/files_antivirus/archive/v0.2.tar.gz)
+ * `git clone git://github.com/valarauco/files_antivirus.git`
+* Unpack the tarball inside the apps directory of Owncloud
+* Activate the App
+* Go to Admin Panel and configure the App
+
+
+Author: 
+[Manuel Delgado López](https://github.com/valarauco/) :: manuel.delgado at ucr.ac.cr