You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

39 lines
993 B

9 years ago
9 years ago
9 years ago
9 years ago
  1. # Telegraph
  2. Telegraph is an API for sending [Webmentions](http://webmention.net).
  3. ## API
  4. See https://telegraph.p3k.io/api
  5. ## Developing
  6. * Fork and clone this repo.
  7. * Install MySQL, composer, beanstalk, and phpunit if they're not already
  8. installed, e.g. `brew install mysql composer beanstalk phpunit`.
  9. * Start MySQL and `beanstalkd`.
  10. * Copy `config.template.php` to `config.test.php`. Update the appropriate values
  11. for your local environment if necessary.
  12. * Run these commands to install the dependencies, create a local database, and
  13. run the tests:
  14. ```sh
  15. $ composer install
  16. $ mysql [ARGS] -e 'CREATE DATABASE telegraph;'
  17. $ mysql [ARGS] < schema.sql
  18. $ phpunit
  19. # Hack hack hack!
  20. ```
  21. ## Credits
  22. Telegraph photo: https://www.flickr.com/photos/nostri-imago/3407786186
  23. Telegraph icon: https://thenounproject.com/search/?q=telegraph&i=22058
  24. ## License
  25. Copyright 2016 by Aaron Parecki
  26. Available under the Apache 2.0 license. See [LICENSE](LICENSE).