andy/neoCMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 11 Wiki Activity

Update README.md

Browse Source 
Rewrote to be more public, added LICENSE information
This commit is contained in:
Andy Dixon
2024-10-03 08:54:13 +01:00
committed by GitHub
parent af7650c4d4
commit b2b7f85aba
1 changed files with 33 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+33 -13
View File
@@ -1,24 +1,44 @@
# NeoCMS # NeoCMS
## Version 2.0 ## Version 2.0
Version 2.0 is a complete rewrite to ensure we support the latest jQuery and TinyMCE GPL version. Welcome to NeoCMS, the super lightweight, database-free content management system! Built with PHP and JavaScript, NeoCMS is designed to be fast and easy to use. No complicated setup required—just drop it into your static website, and you’re good to go.
To install: Version 2.0 is a complete overhaul to support the latest versions of jQuery and TinyMCE (GPL). We’ve made things even smoother for your content editing experience.
* Drop in the CMS folder into a static website ## Features
* Drop in the uploads folder into the static website
* Edit credentials in /cms/init.php for any users that are required * No Database Required: NeoCMS works without a database, so you don’t have to worry about setup hassles or performance slowdowns.
* Update editable divs to contain the class 'editable' * Easy Content Editing: With our intuitive WYSIWYG editor, anyone can update content without writing a single line of code.
* It _should_ then just work by visiting /cms/ and logging in * Seamless Integration: Simply add the CMS to any existing static website. Just assign a special class to the elements you want to make editable, and you’re all set.
* Consistent Layouts: NeoCMS supports page templates to keep your layouts neat and uniform across all pages.
## Installation Guide
Ready to get started? Just follow these simple steps:
* Drop the CMS folder into your static website.
* Add the uploads folder to your site as well.
* Open /cms/init.php and edit the credentials for any users you want to set up.
* Update the div elements you want to make editable by adding the class editable.
* Visit /cms/, log in, and start editing!
That’s it! You’re up and running.
## Requirements ## Requirements
* PHP 8 on Linux. None of that Windows Server crap * PHP 8 running on a Linux server. (May work on Windows servers, but don't want to stoo to that level)
## Known Bugs ## Known Bugs & Issues
* File (not images) uploads need to be implemented * File Uploads (non-image): Currently, file uploads are not fully implemented. We're working on it!
* Not completely tested * Testing: The system is functional, but it hasn’t been fully tested in all scenarios.
If any issues arise, raise it as a bug in the issues page on GitHub ## License
NeoCMS is open-source software licensed under the GNU General Public License v3.0 (GPLv3). You are free to use, modify, and distribute this software under the terms of this license.
For more information, see the full GPLv3 License found in LICENSE.
## Found a Bug?
If you run into any issues or have feature requests, please submit them on our GitHub issues page. Your feedback helps us improve NeoCMS!