Goals of the project in the README

DotNetHypermedia / DotNetHypermedia

Hal media type server side library for .NET

MIT License

14 stars 6 forks source link

Goals of the project in the README #10

Open glennblock opened 9 years ago

glennblock commented 9 years ago

It would be nice to see a more detailed description of the goals for the project. What are the specific outcomes it hopes to achieve? This should be in the readme.

Currently there is a high level description, but I'd like to see something more specific. For example is this just about having a formatter abstraction?

JakeGinnivan commented 9 years ago

I put some information in Contributing.md, they should also be in the readme.

https://github.com/DotNetHypermedia/DotNetHypermedia/blob/master/Contribute.md

glennblock commented 9 years ago

That's a start, but still too high level. What are the components of a hypermedia system? What will the project deliver. What's there currently makes a lot of assumptions. For example is this server only? Will it also address client consumption as well? Where does the web framework that is using this stop and this starts, what's the line?

glennblock commented 9 years ago

Looking in the issues, I see a lot of energy, but it feels like it's going into the weeds quickly.

glennblock commented 9 years ago

Looking at what you have in #1, there's some good stuff there that could go into the README.

JakeGinnivan commented 9 years ago

I am not sure what the scope is yet, but I agree it could be really easy to lose momentum and it fizzle.

Thinking this to start:

Goals

The current scope of this project is

Give a framework agnostic API to define hypermedia as well as many of the normal building blocks you need (link templating etc).
Serialisation to different hypermedia formats
- Initially Hal and Collection+Json
- Once the concept has been proven with those two hypermedia formats then more can be added
Integration into the various web frameworks like Nancy, WebApi, ServiceStack by leveraging the serialisation provided above
Bring the developers of the below libraries together to reduce the duplication across those projects and collectively solve common issues when implementing hypermedia systems

glennblock commented 9 years ago

This is good. I would also add support for clients and servers.

glennblock commented 9 years ago

The hardest part of building an HM system is the client. That's the side that often gets overlooked. So in the same way as i want to use diff web frameworks, maybe I want to use RestSharp for my client instead of MS HttpClient(s)