improve license notices
[vpn-setup] / README
diff --git a/README b/README
index adc781afb9a98775df2319068faa08131a004afc..a8427ce56dcb2a21b5e98af336caf4c6beb3fb7b 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,29 @@
-Setup vpn server and client to vpn all traffic
+# I, Ian Kelling, follow the GNU license recommendations at
+# https://www.gnu.org/licenses/license-recommendations.en.html. They
+# recommend that small programs, < 300 lines, be licensed under the
+# Apache License 2.0. This file contains or is part of one or more small
+# programs. If a small program grows beyond 300 lines, I plan to switch
+# its license to GPL.
+
+# Copyright 2024 Ian Kelling
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Setup openvpn client & server
+
+For a general purpose script, I would recommend
+https://github.com/Angristan/openvpn-install instead of this, but this
+should still work for other people if they want to try.
 
 The main documentation is availiable via --help and near the top of the bash
 script files which sit next to this file.