diff --git a/README.md b/README.md index 735b2b3..15ebe30 100644 --- a/README.md +++ b/README.md @@ -35,9 +35,9 @@ ## Quick Start 1. git clone https://github.com/gnh1201/reasonableframework.git -2. set up database configuration: `/storage/config/database.ini.php` +2. edit database configuration: `/storage/config/database.ini.php` 3. create new file: `/route/example.php` -4. go to `http://[base_url]/?route=example` or `http://[base_url]/example/`(if set `.htaccess`) in your web browser. +4. go to `http://:base_url/?route=example` or `http://:base_url/example/`(if set `.htaccess`) in the web browser. 5. code it. ## Examples @@ -50,7 +50,7 @@ - Firewall, DDoS protection, and more security tools are available only for sponsors. [more](https://github.com/gnh1201/reasonableframework/blob/master/SECURITY.md) ## Remote logger (free for all) -- Remote logger feature based on [RFC3164(The BSD Syslog Protocol)](https://catswords.re.kr/go/rfc3164), with [Papertrail](https://catswords.re.kr/go/papertrail) +- Remote logger feature based on [RFC3164(The BSD Syslog Protocol)](https://tools.ietf.org/html/rfc3164), with [Papertrail](https://www.papertrail.com/) ## Compatible of free web hostings @@ -71,7 +71,7 @@ ## How to use CLI (Command line interface) ``` -$ php cli.php --route [route name] --session-id [session ID] +$ php cli.php --route :route --session-id :session_id ``` ## Administratives @@ -86,7 +86,8 @@ $ php cli.php --route [route name] --session-id [session ID] - Composer(패키지 관리자)를 포함한 별도의 개발 보조 도구, PHP 플러그인, PHP 프레임워크가 사용 불가능한 환경에 적합합니다. - 한국에서 사용되는 각종 CMS와 API와 연동되어 한국 환경에서 사용 빈도가 높은 구현 유형을 작성하는데 적합합니다. - RVHM 구조는 MVC 구조와 함께 사용하실 수 있으며, 기존 개발 스킬로도 사용할 수 있도록 더 유연한 구조를 가집니다. -- **리즈너블 프레임워크**는 CSRF, XSS, SQL 인젝션 등 기초적인 **보안 위협에 대응**하도록 설계되어 있습니다. +- **리즈너블 프레임워크**는 CSRF, XSS, SQL 인젝션 등 기초적인 **보안 위협에 대응**하도록 설계되어 있습니다 +- **리즈너블 프레임워크**는 `Forwarded` 헤더를 자체적으로 지원하여 부하 분산이나 익명 웹사이트 구축(예를 들어, Tor)에 적합합니다. - 이 프로젝트는 PHP 버전 4 부터 버전 7까지 다양한 **기업 수준의 적용 사례**를 포함하고 있습니다. - 이 프로젝트는 [카카오톡 채팅방](https://catswords.re.kr/go/kakaotalk)에서 실시간으로 버그 및 보안 이슈를 제보받고 있습니다. @@ -99,6 +100,7 @@ $ php cli.php --route [route name] --session-id [session ID] - Compatible with famous CMS and API used with REST API, it is suitable to create implementation type that is frequently used in various environment. - RVHM structure can be used with MVC structure, and has more flexible structure to use as existing development skills. - **ResonableFramework** is designed to **respond to fundamental security threats** such as CSRF, XSS, and SQL injection. +- **ResonableFramework** is supported `Forwarded` headers natively, so it is ideal for build a load balancing or hidden(for example, Tor) services. - This project including a lots of the **enterprise level cases** from PHP version 4(legacy) to 7(modern). - This project receiving a realtime reports that bugs and security issues in the [official chatting room](https://catswords.re.kr/go/kakaotalk).