chore: rename to php-parser-rs

This commit is contained in:
Ryan Chandler 2022-11-27 02:44:57 +00:00
parent ca45b213e5
commit e9c4b54d99
2 changed files with 5 additions and 26 deletions

View File

@ -1,5 +1,5 @@
[package]
name = "trunk_parser"
name = "php-parser-rs"
version = "0.1.0"
edition = "2021"

View File

@ -1,37 +1,16 @@
<h3 align="center">
Trunk
php-parser-rs
</h3>
<p align="center">
A collection of modern libraries and tools for working with PHP.
A handwritten recursive-descent PHP parser written in Rust, for fun.
</p>
---
<p align="center">
<a href="https://discord.gg/49vgTdE6mb">
<img src="https://img.shields.io/badge/Trunk-%237289DA.svg?style=for-the-badge&logo=discord&logoColor=white">
</a>
</p>
#### Overview
The Trunk project originally started with me ([Ryan](https://github.com/ryangjchandler)) experimenting with a handwritten recursive-descent parser for PHP written in Rust. The parser evolved very quickly and I found myself already being able to parse relatively complex programs that I had written myself.
Once I had something worth sharing, I created this GitHub repository and some people were interested in what I was doing. Since then, it's become a hobby project for myself and I tend to work on it in my spare time.
The current goal for Trunk is to get a fully functional parser up and running so that it can be used in some meaningful projects, aimed at bringing the speed and performance of modern PHP tooling closer to that of [our](https://deno.land) [cousins](https://bun.sh) in [JavaScript](https://swc.rs/) [land](https://esbuild.github.io).
#### Libraries and Tools
* [Lexer](/trunk_lexer/)
* [Parser](/trunk_parser/)
> Neither of these projects are production-ready so please don't use them for anything critical.
#### Contributing
All contributions to Trunk are welcome. It's the perfect project for Rust beginners since we don't use many of Rust's complex features and the core concepts in the parser are purposely simple.
All contributions to this repository are welcome. It's the perfect project for Rust beginners since we don't use many of Rust's complex features and the core concepts in the parser are purposely simple.
If you do wish to contribute, we just ask you to follow a few simple rules.
@ -42,4 +21,4 @@ If you do wish to contribute, we just ask you to follow a few simple rules.
#### Credits
* [Ryan Chandler](https://github.com/ryangjchandler)
* [All contributors](https://github.com/ryangjchandler/trunk/graphs/contributors)
* [All contributors](https://github.com/ryangjchandler/php-parser-rs/graphs/contributors)