From d75ab3c422e7f1439c65e4f98600996805f87793 Mon Sep 17 00:00:00 2001
From: hakasenyang <contact@hakase.kr>
Date: Wed, 2 Nov 2016 08:50:29 +0900
Subject: [PATCH] Create README.md

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..57f85f5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# marumaru-php-parser
+마루마루 사이트의 PHP 파싱 파일입니다. fmaru 관련 포팅 자료도 있습니다.
+
+## 제공 파일
+* Fmaru 포팅
+* marumaru API (이미지 주소를 json 으로 출력)
+* 기타...
+
+## 예시 사이트
+[Hakase's Marumaru API](https://marumaru.hakase.kr/)
+
+## 사용 방법
+1. 해당 파일을 다운로드 받아서 권한을 777로 주면 끝납니다 (...)
+1-1. 권한은 cookie.txt, mangalist.txt (쿠키 캐싱) 파일을 생성하기 위해 필요합니다.
+2. api 관련 rewrite 는 아래를 참고하십시오. (nginx 기준)
+2-1. rewrite 없이 사용하려면 소스를 수정하셔야 합니다.
+```
+rewrite ^/api/(.*)/(.*)$ /index.php?num=$1&json=1;
+rewrite ^/api/(.*)$ /index.php?num=$1;
+rewrite ^/img/(.*)$ /image.php?num=$1;
+rewrite ^/fmaru$ /fmaru.php;
+```
+
+## Fmaru 포팅 원본 소스
+Fmaru 관련 포팅의 원본 소스는 [fmaru's github](https://github.com/fmaru/fmaru) 에서 확인하실 수 있습니다.
+
+## Sucuri proxy 소스
+Sucuri proxy 관련 소스는 아래와 같은 사이트에서 가져왔습니다.
+[organization's cloudflare-bypass](https://github.com/organization/cloudflare-bypass)
+[코드팟's PHP Sucuri Proxy](http://cafe.naver.com/gogoomas/337647)
+
+## 저작권
+MIT License 를 따릅니다. fmaru 의 작품(?)처럼 마음껏 수정해서 광고를 달던 어떻게 사용하던 상관 없습니다.