Permalink
Browse files

Replace readme content.

  • Loading branch information...
1 parent 1895adf commit 9696b412df3372bc5bc2a2551c7af4471bcf6e3a @gocom gocom committed Nov 19, 2013
Showing with 3 additions and 104 deletions.
  1. +3 −104 README.textile
View
107 README.textile
@@ -1,106 +1,5 @@
-h1. TEXTILE HAS MOVED
+h1. PHP-Textile has moved
-This is no longer the home repo for Textile. It is now housed under the textile github organization at "textile/php-textile":https://github.com/textile/php-textile.
+This is no longer the home repository for PHP-Textile. It is now housed under the "Textile":https://github.com/textile GitHub organization at "textile/php-textile":https://github.com/textile/php-textile.
-*Do Not Fork This Repo* fork _textile/php-textile_ instead.
-
-
-h2. Textile for PHP
-
-"Downloads":https://github.com/textile/php-textile/releases | "Textile reference":http://txstyle.org/article/43/a-short-introduction | "Live editor":http://txstyle.org/ | "Packagist":https://packagist.org/packages/netcarver/textile
-
-*Textile is a humane web text generator*. It takes lightweight, readable, plaintext-like markup language and converts it into well formed HTML. This repository contains a Textile parser for PHP.
-
-h2. Branches
-
-|^=. "master":https://github.com/textile/php-textile/tree/master | Has a multi-file, namespaced, "PSR-0/1/2":https://github.com/php-fig/fig-standards/tree/master/accepted compliant version of Textile. Releases from master are tagged v3.5.x !https://travis-ci.org/textile/php-textile.png?branch=master!:https://travis-ci.org/textile/php-textile |^=. _Requires PHP5.3+_ |
-|^=. "2.5":https://github.com/textile/php-textile/tree/2.5 | Holds a single-file version of Textile representing the v2.5.x releases. It is *not* PSR-0 compliant but attempts to follow PSR-1 and PSR-2 in other respects. !https://travis-ci.org/textile/php-textile.png?branch=2.5!:https://travis-ci.org/textile/php-textile |^=. _Requires PHP5.0+_ |
-
-*This is the README for the master branch.*
-
-Currently both branches are feature synchronised at the point they are tagged, and new features and bugfixes will go into both branches (where possible) for the time being, but this _will_ change at some point in the future.
-
-From time to time other branches may be present in the repository. These represent transient development or hotfix branches and should not be used for live sites/projects.
-
-h2. Installing
-
-h3. Using Composer
-
-The recommended way to install Textile is via "Composer":https://getcomposer.org/ package manager. Navigate to your project directory, and run the command:
-
-bc. $ composer require "netcarver/textile 3.5.*"
-
-If you haven't yet used Composer, you will then want to include the autoloader file generated by Composer in your project:
-
-bc. require './vendor/autoload.php';
-
-h3. Manually
-
-You can also install Textile library manually. The library supports any PSR-0 style autoloaders, but you can also include the source files in your project manually. "Download":https://github.com/textile/php-textile/releases the repository, and include the source files:
-
-bc. require 'path/to/src/Netcarver/Textile/Parser.php';
-require 'path/to/src/Netcarver/Textile/DataBag.php';
-require 'path/to/src/Netcarver/Textile/Tag.php';
-
-Or point your PSR-0 autoloader to the Textile installation location.
-
-h2. Usage
-
-Textile parser can be accessed through the @Netcarver\Textile\Parser@ class. The class is highly configurable, and actual parsing happens with the @textileThis@ and @textileRestricted@ methods:
-
-bc. use Netcarver\Textile\Parser as Textile;
-$parser = new Textile();
-echo $parser->textileThis('h1. Hello World!');
-
-h3. Parsing untrusted input
-
-If you are using Textile to format user-supplied input, blog comments for instance, use the @textileRestricted()@ method:
-
-bc. $parser = new \Netcarver\Textile\Parser();
-echo $parser->textileRestricted('!bad/image/not/allowed.svg!');
-
-The method doesn't allow more powerful formatting options such as inline style, and removes any raw HTML.
-
-h3. Doctypes
-
-Currently, PHP Textile can target either XHTML or HTML5 output with XHTML being the default for backward compatibility. The targeted doctype can be changed through the constructor:
-
-bc. $parser = new \Netcarver\Textile\Parser('html5');
-echo $parser->textileThis('HTML(HyperText Markup Language)");
-
-In HTML5 mode, you'll get @abbr@ instead of @acronym@ and if you use alignment markers on your images you'll have extra classes placed on them instead of XHTML's @align@ attribute.
-
-h3. Setting alternate glyphs
-
-Textile's typographic substitutions can be overridden with the @setSymbol@ method. If you need to setup Textile to do non-standard substitutions, call @setSymbol@ before you parse the input with @textileThis@ or @textileRestricted@.
-
-bc. $parser = new \Netcarver\Textile\Parser();
-$parser->setSymbol('half', '1⁄2');
-$parser->textileThis('Hello [1/2] World!');
-
-The symbol names you can pass to @setSymbol()@ can be found "here":https://github.com/textile/php-textile/blob/582fb7e2af83bb043fe6dd3846220796c814f999/classTextile.php#L468.
-
-h3. Prefixing relative image paths
-
-Setting a image path prefix might be useful if your application only allows users to reference images from a certain location like, say, an images directory. The prefix can be set with the @setRelativeImagePrefix()@ method:
-
-bc. $parser = new \Netcarver\Textile\Parser();
-$parser->setRelativeImagePrefix('user/uploads');
-$parser->textileThis('Hello World!');
-
-h2. Running tests
-
-Included unit tests can be run with PHPunit:
-
-bc. $ composer install --dev
-$ ./vendor/bin/phpunit
-
-Running tests requires PHP 5.3.3 and PCRE with PCRE_UTF8.
-
-h2. Getting in contact
-
-The Textile project welcomes constructive input and bug reports from users. You can contact us in several ways...
-
-* "Open an issue":https://github.com/textile/php-textile/issues on the repository for a feature request or bug.
-* If you are on IRC, feel free to drop into *#textile* on *freenode.net* ("webchat":http://webchat.freenode.net/?channels=#textile.)
-* Use the generic "contact form":http://sitemonks.com/.
+*Do not fork this repo*, fork _textile/php-textile_ instead.

2 comments on commit 9696b41

@gocom
Collaborator

@netcarver Can you replace the repository description and homepage URL?

Description: This repository has been moved
URL: https://github.com/textile/php-textile

@netcarver
Owner

@gocom Done.

Please sign in to comment.