Browse Source

Update license and readme

master
Skylar Ittner 4 months ago
parent
commit
3ed75822a1
2 changed files with 12 additions and 19 deletions
  1. 3
    15
      LICENSE.md
  2. 9
    4
      README.md

+ 3
- 15
LICENSE.md View File

@@ -1,19 +1,7 @@
1
-Copyright (c) 2018 Netsyms Technologies.
1
+Copyright (c) 2017-2019 Netsyms Technologies.  Some rights reserved.
2 2
 
3
-If you modify and redistribute this project, you must replace the branding
4
-assets with your own.
5
-
6
-The branding assets include:
7
- * the application icon
8
- * the Netsyms N punchcard logo
9
- * the Netsyms for Business graph logo
10
-
11
-If you are unsure if your usage is allowed, please contact us:
12
-https://netsyms.com/contact
13
-legal@netsyms.com
14
-
15
-All other portions of this application,
16
-unless otherwise noted (in comments, headers, etc), are licensed as follows:
3
+Licensed under the Mozilla Public License Version 2.0.  Files without MPL header
4
+comments, including third party code, may be under a different license.
17 5
 
18 6
 Mozilla Public License Version 2.0
19 7
 ==================================

+ 9
- 4
README.md View File

@@ -11,6 +11,10 @@ Program Structure
11 11
 -----------------
12 12
 
13 13
 ### Folders
14
+* api
15
+   An API framework.  See api/apisettings.php below.
16
+* api/actions
17
+   A place to put your API actions.
14 18
 * langs
15 19
    Translations and alert messages.
16 20
    The language files that are loaded depends on the value of `LANGUAGE` in `settings.php`.
@@ -22,7 +26,7 @@ Program Structure
22 26
    The app checks before loading, so it will give a friendly 404 error if it doesn't find your page.
23 27
    Woe to you if you delete `home.php` or `404.php`, as those are assumed to exist for fallback behavior.
24 28
 * static
25
-   CSS, JS, fonts, images...
29
+   CSS, JavaScript, fonts, images...
26 30
 * vendor
27 31
    If you don't know what this is about, or you don't have it, you need to read up on Composer.  Right now.
28 32
 
@@ -41,11 +45,12 @@ Program Structure
41 45
    Read through it to see exactly what it does.
42 46
 * action.php
43 47
    A good place to put form handling code.  By default it only handles logging out, but is easily expanded.
48
+* api/apisettings.php
49
+   An array of API actions.  Validates any variables required by your actions before running them.  See https://source.netsyms.com/Apps/NotePost/src/branch/master/api/apisettings.php for a full example of its capabilities.
44 50
 * api.php
45
-   Similar to action.php, but designed for user/pass authenticated JSON responses.
51
+   Legacy shim for code that still expects the API endpoint to be here.
46 52
 * index.php
47
-   Login page and handler.  Hands off to `app.php` after authenticating user.
48
-   It includes 2fa support, by the way.
53
+   Handles login and checking permissions.
49 54
 * app.php
50 55
    Main app page after login.  Handles loading app pages and 404 errors.
51 56
    Redirects to `index.php` if the user is not logged in.

Loading…
Cancel
Save