Skip to content

Commit

Permalink
[TASK] Switch documentation to Markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
mrimann committed Dec 6, 2014
1 parent c4e4fe6 commit 70976ea
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 50 deletions.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
## Note on the project status!
This project is still here, and as far as I know the script still works. But as I don't use Kippt anymore at the very moment, I also don't use this script.

**This Project is not actively maintained aynmore!** Feel free to submit bugfixes/changes and I'll try to apply them - but I won't fix bugs or add features for now.


## What's this all about?

I started playing around with [kippt.com](http://www.kippt.com) which looks promising as a successor for the beloved del.icio.us which (since acquired by that big company) lost a lot of the power that I liked. And since I already had a del.icio.us to MySQL-Backup script in place, I thought something like that needs to be possible with kippt.com, too.

And here we go: A rough first draft of a kippt.com backup script - maybe a migration tool from del.icio.us to kippt.com will follow.


## Backing up all your kippt.com bookmarks to MySQL:

### How to do?

1. Clone this repository

2. Create a database with a table called "clips" (see database schema file in the cloned directory)

3. Copy config.sample.php to config.php and enter your local database credentials together with your kippt.com username and API-Token
You can find your kippt.com API-Token by visiting the following "page" with your browser while being logged in: https://kippt.com/api/account

4. Run the script : php -f kipptBackup.php


### Contributors

The following persons have supported the kippt-tools development:

- Sébastien Wains, https://github.com/sebw
- Fetching of clips in batches
- Showing some nice progress

Thanks for your contribution!

## Feedback?

Please yes - just send it to mario@rimann.org and let's see what I can make out of it. Of course nice "thank you" mails are appreciated most :-) For other ideas on how to support me, just have a look at http://rimann.org/support


## Found a bug or want an additional feature?

Don't worry, just [open an issue on GitHub](https://github.com/mrimann/kippt-tools/issues) or even better: Fix it and contribute it back to the project. You can fork the sourcecode from the Git repository and send me a pull request as soon as you've finished.

## License

Licensed under the permissive [MIT license](http://opensource.org/licenses/MIT) - have fun with it!
50 changes: 0 additions & 50 deletions README.rst

This file was deleted.

0 comments on commit 70976ea

Please sign in to comment.