diff options
author | Cydrobolt <summermontreal@gmail.com> | 2014-02-14 19:41:47 +0400 |
---|---|---|
committer | Cydrobolt <summermontreal@gmail.com> | 2014-02-14 19:41:47 +0400 |
commit | 0357332157a84b26359f1b5139bf59b15f0c2b06 (patch) | |
tree | 74d2c0396091ac37fd74c467f79b441d8e026103 | |
parent | 68b7642e8be82d57a525c4ad1f9e9ae9736cffa4 (diff) |
new readme's
-rw-r--r-- | README.md | 25 | ||||
-rw-r--r-- | releases/README.md | 6 |
2 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..122d3f9 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +polr information +================== + +A URL Shortner with simple API + +Polr's code is separated into three folders. + +Developers wanting to intergrate Polr into their app/website should go to /releases/ and read the /docs/ +Prospective contributors should go to /dev/ + + + Copyright (C) 2014 Polr + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. diff --git a/releases/README.md b/releases/README.md index 16ad5cd..a8ec7d3 100644 --- a/releases/README.md +++ b/releases/README.md @@ -6,12 +6,18 @@ A URL Shortner with simple API If this folder is empty, that means no versions have been released yet. Please check back later. Otherwise, choose the release that you wish to use and download it. Releases with _BETA or _ALPHA in their filenames could be unstable. An install guide will be created soon. + + Requirements for Polr: + + One MySQL Database + A PHP-enabled web server + Copyright (C) 2014 Polr This program is free software: you can redistribute it and/or modify |