Updated / Fixed readme, also add license information all over the pla…

…ce, since people are misusing the code and violating the license.
JonasCz · Feb 6, 2016 · 6b9b7d4 · 6b9b7d4
1 parent 3a4b04e
commit 6b9b7d4
Show file tree

Hide file tree

Showing 17 changed files with 442 additions and 42 deletions.
diff --git a/README.md b/README.md
@@ -1,66 +1,86 @@
 #### Note:
-Do not use the Play Store version, it is outdated and broken.
+Do not use the Play Store version, as it is outdated and broken.
 
 # Save For Offline
 
-Save for offline is an Android app for saving webpages for offline reading.
+Save For Offline is an Android app for saving full webpages for offline reading, with lots of features and options.
+
+In you web browser select 'Share', and then 'Save For Offline'
+
+## Features
+
+* Save real HTML files which can be opened in other apps / devices
+
+* Download & save entire web pages with all assets for offline reading & viewing
+
+* Save HTML files in a custom directory
+
+* Save in the background, no need to wait for it to finish saving
+
+* Night mode, with both a dark theme, and can invert colors when viewing pages (White becomes black and vice-versa).
+
+* Search of saved pages (By title only for now).
+
+* User agent change, allows to save either desktop or mobile version of pages
+
+* Nice UI (In my opinion anyway & needs more testing on different devices and screen sizes)
 
-In you web browser select 'share' , and then 'Save For Offline'
 
 ## Screenshots
 #### Grid layout for the list of all saved pages.
 ![Grid layout](https://raw.githubusercontent.com/JonasCz/save-for-offline/master/screenshots/gridlayout.png)
 ***
 
-#### List layout with details.
-![List layout](https://raw.githubusercontent.com/JonasCz/save-for-offline/master/screenshots/listlayout.png)
+#### List of all saved pages, running on a small-screen device with night mode enabled.
+![List layout](https://raw.githubusercontent.com/JonasCz/save-for-offline/master/screenshots/list_small_night.png)
 ***
 
-#### Built in viewer. (Saved HTML files can also be opened in other apps or copied to computer)
-![Viewer](https://raw.githubusercontent.com/JonasCz/save-for-offline/master/screenshots/viewer.png)
+#### Built in viewer, again on a small screen, with night mode enabled (Saved HTML files can also be opened in other apps or copied to computer)
+![Viewer](https://raw.githubusercontent.com/JonasCz/save-for-offline/master/screenshots/viewer_small_night.png)
 ***
 
+More screenshots can be found in the [screenshots directory](https://github.com/JonasCz/save-for-offline/master/screenshots/).
 
 ## Download
 
-Head to the [Releases section](http://github.com/JonasCz/save-for-offline/releases) to download the APK.  *Not available on Google Play yet.*
-
-Please report any bugs you find, and contribute if you can!
+* Head to the [Releases section](http://github.com/JonasCz/save-for-offline/releases) to download an APK.
 
+* It's also available [on F-Droid]()
 
-## It can
+Remember: The play store version is old, broken, and not recommended !
 
-* **Save real HTML**  files which can be opened in other apps / devices
-* Download & **save entire web pages for offline reading & viewing**
-* **Save in the background**, no need to wait for it to finish saving
-* Nice UI (In my opinion anyway & needs more testing on different devices and screen sizes)
+Please report any bugs you find, and contribute if you can!
 
 ## About
 
 #### This app uses
 
-*  [WebArchiveReader](http://github.com/gregko/webArchiveReader/) thanks to StackOverflow user [Gregko](http://github.com/JonasCz/save-for-offline/releases)
-
 * [FuzzyDateFormatter](http://github.com/igstan/fuzzyDateFormatter/)
 
-* [GetMeThatPage](https://github.com/PramodKhare/GetMeThatPage/)
+* [GetMeThatPage](https://github.com/PramodKhare/GetMeThatPage/) (not anymore)
+
+* OkHttp
 
 * [jSoup](http://jsoup.org)
 
-#### Licence is GPL, see the LICENCE file
+#### Licence is GPLv2+, see the LICENCE file.
 
+**Note:** Don't use or modify my code unless you can comply with the license, and release the source
+code of your modifications where necessary. I don't want to see my hard work end up in some commercial
+app, and it already has. Thanks.
+
+```
+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 2 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, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 ```
-    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 2 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, write to the Free Software Foundation, Inc.,
-    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-```
diff --git a/app/src/main/java/jonas/tool/saveForOffline/AddActivity.java b/app/src/main/java/jonas/tool/saveForOffline/AddActivity.java
@@ -1,3 +1,39 @@
+/**
+ 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 2 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/>.
+
+ **/
+
+/**
+ This file is part of Save For Offline, an Android app which saves / downloads complete webpages for offine reading.
+ **/
+
+/**
+ If you modify, redistribute, or write something based on this or parts of it, you MUST,
+ I repeat, you MUST comply with the GPLv2+ license. This means that if you use or modify
+ my code, you MUST release the source code of your modified version, if / when this is
+ required under the terms of the license.
+
+ If you cannot / do not want to do this, DO NOT USE MY CODE. Thanks.
+
+ (I've added this message to to the source because it's been used in severeral proprietary
+ closed source apps, which I don't want, and which is also a violation of the liense.)
+ **/
+
+/**
+ Written by Jonas Czech (JonasCz, stackoverflow.com/users/4428462/JonasCz and github.com/JonasCz). (4428462jonascz/eafc4d1afq)
+ **/
+
 package jonas.tool.saveForOffline;
 
 

diff --git a/app/src/main/java/jonas/tool/saveForOffline/Database.java b/app/src/main/java/jonas/tool/saveForOffline/Database.java
@@ -1,3 +1,39 @@
+/**
+ 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 2 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/>.
+
+ **/
+
+/**
+ This file is part of Save For Offline, an Android app which saves / downloads complete webpages for offine reading.
+ **/
+
+/**
+ If you modify, redistribute, or write something based on this or parts of it, you MUST,
+ I repeat, you MUST comply with the GPLv2+ license. This means that if you use or modify
+ my code, you MUST release the source code of your modified version, if / when this is
+ required under the terms of the license.
+
+ If you cannot / do not want to do this, DO NOT USE MY CODE. Thanks.
+
+ (I've added this message to to the source because it's been used in severeral proprietary
+ closed source apps, which I don't want, and which is also a violation of the liense.)
+ **/
+
+/**
+ Written by Jonas Czech (JonasCz, stackoverflow.com/users/4428462/JonasCz and github.com/JonasCz). (4428462jonascz/eafc4d1afq)
+ **/
+
 package jonas.tool.saveForOffline;
 
 

diff --git a/app/src/main/java/jonas/tool/saveForOffline/DirectoryHelper.java b/app/src/main/java/jonas/tool/saveForOffline/DirectoryHelper.java
@@ -1,3 +1,39 @@
+/**
+ 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 2 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/>.
+
+ **/
+
+/**
+ This file is part of Save For Offline, an Android app which saves / downloads complete webpages for offine reading.
+ **/
+
+/**
+ If you modify, redistribute, or write something based on this or parts of it, you MUST,
+ I repeat, you MUST comply with the GPLv2+ license. This means that if you use or modify
+ my code, you MUST release the source code of your modified version, if / when this is
+ required under the terms of the license.
+
+ If you cannot / do not want to do this, DO NOT USE MY CODE. Thanks.
+
+ (I've added this message to to the source because it's been used in severeral proprietary
+ closed source apps, which I don't want, and which is also a violation of the liense.)
+ **/
+
+/**
+ Written by Jonas Czech (JonasCz, stackoverflow.com/users/4428462/JonasCz and github.com/JonasCz). (4428462jonascz/eafc4d1afq)
+ **/
+
 package jonas.tool.saveForOffline;
 import android.content.SharedPreferences;
 import android.os.Environment;

diff --git a/app/src/main/java/jonas/tool/saveForOffline/DisplayAdapter.java b/app/src/main/java/jonas/tool/saveForOffline/DisplayAdapter.java
@@ -1,3 +1,39 @@
+/**
+ 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 2 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/>.
+
+ **/
+
+/**
+ This file is part of Save For Offline, an Android app which saves / downloads complete webpages for offine reading.
+ **/
+
+/**
+ If you modify, redistribute, or write something based on this or parts of it, you MUST,
+ I repeat, you MUST comply with the GPLv2+ license. This means that if you use or modify
+ my code, you MUST release the source code of your modified version, if / when this is
+ required under the terms of the license.
+
+ If you cannot / do not want to do this, DO NOT USE MY CODE. Thanks.
+
+ (I've added this message to to the source because it's been used in severeral proprietary
+ closed source apps, which I don't want, and which is also a violation of the liense.)
+ **/
+
+/**
+ Written by Jonas Czech (JonasCz, stackoverflow.com/users/4428462/JonasCz and github.com/JonasCz). (4428462jonascz/eafc4d1afq)
+ **/
+
 package jonas.tool.saveForOffline;
 
 import android.content.*;

diff --git a/app/src/main/java/jonas/tool/saveForOffline/FaviconFetcher.java b/app/src/main/java/jonas/tool/saveForOffline/FaviconFetcher.java
@@ -1,3 +1,39 @@
+/**
+ 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 2 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/>.
+
+ **/
+
+/**
+ This file is part of Save For Offline, an Android app which saves / downloads complete webpages for offine reading.
+ **/
+
+/**
+ If you modify, redistribute, or write something based on this or parts of it, you MUST,
+ I repeat, you MUST comply with the GPLv2+ license. This means that if you use or modify
+ my code, you MUST release the source code of your modified version, if / when this is
+ required under the terms of the license.
+
+ If you cannot / do not want to do this, DO NOT USE MY CODE. Thanks.
+
+ (I've added this message to to the source because it's been used in severeral proprietary
+ closed source apps, which I don't want, and which is also a violation of the liense.)
+ **/
+
+/**
+ Written by Jonas Czech (JonasCz, stackoverflow.com/users/4428462/JonasCz and github.com/JonasCz). (4428462jonascz/eafc4d1afq)
+ **/
+
 package jonas.tool.saveForOffline;
 
 import org.jsoup.nodes.Document;

diff --git a/app/src/main/java/jonas/tool/saveForOffline/FuzzyDateFormatter.java b/app/src/main/java/jonas/tool/saveForOffline/FuzzyDateFormatter.java
@@ -1,13 +1,18 @@
+/**
+ This file is part of Save For Offline, an Android app which saves / downloads complete webpages for offine reading.
+ **/
+
+/**
+ * @author Ionut G. Stan <[email protected]>
+ * Modified by JonasCz (Refactored a bit)
+ */
+
 package jonas.tool.saveForOffline;
 
 import java.util.Calendar;
 import java.text.*;
 import java.util.*;
 
-/**
- * @author Ionut G. Stan <[email protected]>
- */
-
 public class FuzzyDateFormatter {
 
     private final static int SECONDS = 1;

diff --git a/app/src/main/java/jonas/tool/saveForOffline/MainActivity.java b/app/src/main/java/jonas/tool/saveForOffline/MainActivity.java
@@ -1,3 +1,39 @@
+/**
+ 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 2 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/>.
+
+ **/
+
+/**
+ This file is part of Save For Offline, an Android app which saves / downloads complete webpages for offine reading.
+ **/
+
+/**
+ If you modify, redistribute, or write something based on this or parts of it, you MUST,
+ I repeat, you MUST comply with the GPLv2+ license. This means that if you use or modify
+ my code, you MUST release the source code of your modified version, if / when this is
+ required under the terms of the license.
+
+ If you cannot / do not want to do this, DO NOT USE MY CODE. Thanks.
+
+ (I've added this message to to the source because it's been used in severeral proprietary
+ closed source apps, which I don't want, and which is also a violation of the liense.)
+ **/
+
+/**
+ Written by Jonas Czech (JonasCz, stackoverflow.com/users/4428462/JonasCz and github.com/JonasCz). (4428462jonascz/eafc4d1afq)
+ **/
+
 package jonas.tool.saveForOffline;
 
 import android.app.*;