Skip to content

Commit

Permalink
Merge branch 'hotfix/update_doc_link'
Browse files Browse the repository at this point in the history
  • Loading branch information
olinox14 committed Jun 15, 2024
2 parents cbc29f6 + d4bdd31 commit dd35c88
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 11 deletions.
Binary file added logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 4 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@

# Path-php

> This library is still under development, **USE WITH CAUTION**.
An **intuitive**, **standalone**, and **object-oriented** library for file and path operations,
inspired by the [path python library](https://github.com/jaraco/path).
An **intuitive**, **standalone**, and **object-oriented** library for file and path operations.

```php
<?php
Expand Down Expand Up @@ -37,7 +34,7 @@ $path->putContent('new readme content');
// And many more...
```

**Full documentation here : [API Documentation](https://olinox14.github.io/path-php/classes/Path-Path.html)**
**Full documentation here : [API Documentation](https://path-php.net/)**


## Requirement
Expand Down Expand Up @@ -98,15 +95,15 @@ Build your docker container :

docker build -t path .

Run it (name can be changed):
Run it (name can be changed):

# On Linux
docker run -v "$(pwd)":/path --name path path

# On Windows
docker run -d -v "%cd%:/path" --name path path

Execute it and install dependencies :
Execute it and install dependencies :

docker exec -it path bash
composer install
Expand Down Expand Up @@ -157,10 +154,6 @@ If you're on Linux, you could create an alias with :

alias phpdoc="docker run --rm -v $(pwd):/data phpdoc/phpdoc:3"

And then run phpdoc with :

phpdoc

## Licence

Path-php is under the [MIT](http://opensource.org/licenses/MIT) licence.

0 comments on commit dd35c88

Please sign in to comment.