diff --git a/composer.lock b/composer.lock index 4d8ba9f..90a135c 100644 --- a/composer.lock +++ b/composer.lock @@ -228,16 +228,16 @@ }, { "name": "gregwar/captcha", - "version": "v1.1.9", + "version": "v1.2.0", "source": { "type": "git", "url": "https://github.com/Gregwar/Captcha.git", - "reference": "4bb668e6b40e3205a020ca5ee4ca8cff8b8780c5" + "reference": "6e5b61b66ac89885b505153f4ef9a74ffa5b3074" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/Gregwar/Captcha/zipball/4bb668e6b40e3205a020ca5ee4ca8cff8b8780c5", - "reference": "4bb668e6b40e3205a020ca5ee4ca8cff8b8780c5", + "url": "https://api.github.com/repos/Gregwar/Captcha/zipball/6e5b61b66ac89885b505153f4ef9a74ffa5b3074", + "reference": "6e5b61b66ac89885b505153f4ef9a74ffa5b3074", "shasum": "" }, "require": { @@ -249,7 +249,7 @@ "require-dev": { "phpunit/phpunit": "^6.4" }, - "type": "captcha", + "type": "library", "autoload": { "psr-4": { "Gregwar\\": "src/Gregwar" @@ -279,9 +279,9 @@ ], "support": { "issues": "https://github.com/Gregwar/Captcha/issues", - "source": "https://github.com/Gregwar/Captcha/tree/master" + "source": "https://github.com/Gregwar/Captcha/tree/v1.2.0" }, - "time": "2020-03-24T14:39:05+00:00" + "time": "2023-03-24T22:12:41+00:00" }, { "name": "jbroadway/urlify", diff --git a/readme.md b/readme.md index 0fbd9ce..2f7019c 100644 --- a/readme.md +++ b/readme.md @@ -1,137 +1,32 @@ -# About TYPEMILL +# Typemill Version 2 -TYPEMILL is a lightweight flat file cms for micro-publishers. You can use it for documentations, manuals, special interest websites, and any other information-driven web-project. You can also enhance Typemill with plugins and generate professional e-books in pdf-format with it. The website http://typemill.net runs with Typemill. +This is the repository of Typemill V2. The alpha-release for version 2 is planned for July 2023. -![TYPEMILL Screenshot](https://typemill.net/media/tm-demo.gif) +If you are looking for version 1 of Typemill, please visit the [master branch](https://github.com/typemill/typemill. -## Features +Join the [newsletter](https://typemill.net/news) to get updates for version 2. -* Website with markdown-files. -* Visual markdown editor (VUE.js) and raw markdown mode. -* Flexible drag & drop navigation. -* Markdown extras with - * table of contents (TOC) - * tables - * footnotes - * abbreviations - * definition lists - * notices - * math (with plugin) - * figures with captions -* Media library with images and files. -* System configurations. -* User management. -* Flexible form management with YAML-files. -* Flexible access rights. -* Themes (with TWIG). -* Plugins (with symfony event dispatcher). +If you want to contribute, then please check the code of Typemill 2 in the folder system > [typemill](https://github.com/typemill/typemill/tree/tm2-dev/system/typemill). -Some plugin highlights are: +## Tech-stack of Typemill 2 -* **Ebooks**: Generate one or many professional pdf books from your typemill website. -* **Register**: Let users register to your website and give them access to pro-content. -* **Subscribe** (in work): Sell subscriptions for premium content with traditional pdf-invoices. +Typemill 2 will use the following tech-stack: -## Requirements +* Slim framework version 4 +* Vue.js version 3 +* Tailwind css -* PHP 7+ -* Apache server -* mod_rewrite and htaccess +With slim framework 4 Typemill 2 will run on PHP 8.0 or 8.1 and higher. -If you run a linux system, then please double check that mod_rewrite and htaccess are active!!! +The code of Typemill 2 will be refactored in most parts. -## Installation +## New license system -Download TYPEMILL from the [TYPEMILL website](http://typemill.net), unzip the files and you are done. +Typemill 2 will stay under the MIT-license. -If you are a developer, you can also clone this repository. To do so, open your command line, go to your project folder (e.g. htdocs) and type: +I will try to update all current plugins and themes to version 2, so that the community can proceed with the further development. - git clone git://github.com/trendschau/typemill.git - -The GitHub-version has no vendor-folder, so you have to update and include all libraries and dependencies with composer. To do so, open your command line, go to your TYPEMILL folder and type: - - composer update - -If you did not use composer before, please go to the [composer website](http://getcomposer.org) and start to learn. - -To run TYPEMILL on a **live** system, simply upload the files to your server - -## Make Folders Writable. - -Make sure that the following folders and all their files are writable (permission 774 recursively): - -* cache -* content -* media -* settings - -You can use your ftp-software for that. - -## Setup - -If you visit your website first, then you will be redirected to the `/setup` page. Please create an initial user and configure your system in the author panel. - -## Login - -You can find your login screen under `/tm/login` or simply go to `/setup` and you will be redirected to the login-page, if the setup has been finished. - -## Documentation - -You can read the full documentation for writers, for theme developers and for plugin developers on the [TYPEMILL website](http://typemill.net). - -## Licence - -TYPEMILL is published under MIT licence. Please check the licence of the included libraries, too. - -## Contributors & Supporters - -* [Severo Iuliano](https://github.com/iusvar) manages the internationalization i18n. -* [Eziquel Bruni](https://github.com/EzequielBruni) edits the typemill documentation. -* [Ricky](https://github.com/rbertram90) developed the discard functionality. -* [vodaris](https://www.vodaris.de) sponsored the development of the search plugin. -* Translations: - * Dutch: [svanlaere](https://github.com/svanlaere) - * French: [Olivier Crouzet](https://github.com/oliviercrouzet) - * German: [trendschau](https://github.com/trendschau) - * Italian: [Severo Iuliano](https://github.com/iusvar) - * Russian: [Hide-me](https://github.com/hide-me) - -## IMPORTANT: How to Contribute - -Contributions are highly welcome. Please follow these rules: - -* If you plan bigger changes, then please create an issue first so we can discuss it. -* Fork the "DEVELOP" branch from typemill. Never use the master branch, because it is protected and only contains tested releases. -* Do your changes. -* After that pull the recent develop branch again to get the latest changes. -* Then make a pull request for the DEVELOP branch. - -You can check the [roadmap for Typemill](https://github.com/typemill/typemill/issues/35) and scroll through the issues. I will mark issues in future that are easy to start with or where help is highly appreciated. - -Here are some contribution-ideas for non-coder: - -* Share Typemill with social media. -* Write about Typemill. -* Improve the documentation. -* Find bugs and errors (open a new issue on github for it). -* Describe some missing features and explain, why they are important for other users. - -Some ideas for devs: - -* Fix a bug. -* Create or port a theme, especially for documentations, knowlegde bases or web-books. -* Create a fancy plugin. -* An auto-update functionality for the core system, for plugins and for themes is highly welcome. -* Improve the accessibility of html and css. -* Write autotests with Cypress. - -For hints, questions, problems and support, please open up a new issue on GitHub. - -## Support - -This is an open source project. I love it and I spend about 20 hours a week on it (starting in 2017). There is no business model right now, but you can support this project with a donation or simply [hire me](https://trendschau.net) for implementations. - -Donate: https://www.paypal.me/typemill +I will also proceed with the development of old and new plugins, but I will use a new commercial license with two different subscription plans. This will help to refinance the open source license of the core system. ## Follow